diff --git a/.gitignore b/.gitignore index 05ad55ac..ef514619 100755 --- a/.gitignore +++ b/.gitignore @@ -60,6 +60,7 @@ containers/conf/angie/modules-available containers/conf/angie/modules-enabled containers/conf/angie/scripts containers/conf/angie/snippets +containers/conf/angie/http-waf # Formateurs .php-cs-fixer.cache diff --git a/.npmrc b/.npmrc deleted file mode 100755 index 385901ba..00000000 --- a/.npmrc +++ /dev/null @@ -1,2 +0,0 @@ -# Nécessaire pour better-typescript-lib -public-hoist-pattern[]=@typescript/* diff --git a/.oxlintrc.json b/.oxlintrc.json deleted file mode 100755 index b3dd9aba..00000000 --- a/.oxlintrc.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "$schema": "./node_modules/oxlint/configuration_schema.json", - "env": { "browser": true, "es2020": true, "es2022": true }, - "categories": { - "correctness": "error", - "nursery": "error", - "pedantic": "error", - "perf": "warn", - "restriction": "error", - "style": "warn", - "suspicious": "error" - }, - "plugins": ["jsdoc", "promise", "unicorn", "jsdoc", "oxc", "promise", "typescript", "unicorn"], - "rules": { - "import/export": "error", - "no-array-for-each": "off", - "no-async-await": "off", - "no-console": "off", - "no-magic-numbers": "warn", - "no-map-spread": "off", - "no-misused-promises": "off", - "no-optional-chaining": "off", - "no-rest-spread-properties": "off", - "no-ternary": "off", - "no-undefined": "off", - "no-unused-expressions": "off", - "no-void": "off", - "prefer-await-to-then": "off", - "promise/prefer-await-to-callbacks": "off", - "sort-imports": "off", - "typescript/array-type": ["error", { "default": "generic", "readonly": "generic" }], - "typescript/consistent-indexed-object-style": ["error", "record"], - "typescript/consistent-type-imports": "error", - "typescript/explicit-function-return-type": "warn", - "unicorn/prefer-dom-node-dataset": "off", - "yoda": ["error", "never"] - } -} diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php index 19bd6c1e..5245c50e 100644 --- a/.php-cs-fixer.dist.php +++ b/.php-cs-fixer.dist.php @@ -1,261 +1,267 @@ -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 d952ef73..6e322646 100755 --- a/.phpactor.json +++ b/.phpactor.json @@ -1,16 +1,10 @@ { "$schema": "./phpactor.schema.json", - "indexer.exclude_patterns": [ - "/vendor/**/Tests/**/*", - "/vendor/**/tests/**/*", - "/var/cache/**/*", - "/vendor/composer/**/*" - ], "language_server.diagnostic_outsource_timeout": 5, - "language_server.diagnostics_on_update": false, "language_server.diagnostics_on_save": true, + "language_server.diagnostics_on_update": true, "language_server_highlight.enabled": true, - "language_server_php_cs_fixer.enabled": true, + "language_server_php_cs_fixer.enabled": false, "language_server_phpstan.config": "phpstan.neon", "language_server_phpstan.enabled": true, "language_server_psalm.enabled": false, diff --git a/.phpantom.toml b/.phpantom.toml new file mode 100644 index 00000000..e9d05ba5 --- /dev/null +++ b/.phpantom.toml @@ -0,0 +1,19 @@ +# :schema: https://github.com/AJenbo/phpantom_lsp/raw/main/config-schema.json + +[php] + # Override the detected PHP version (default: inferred from composer.json, or 8.5). + # version = "8.5" + # + +[diagnostics] + extra-arguments = true + # Report member access on subjects whose type could not be resolved. + # Useful for discovering gaps in type coverage. Off by default. + unresolved-member-access = false + +[indexing] + # How PHPantom discovers classes across the workspace. + # "composer" (default) - use Composer classmap, self-scan on fallback + # "self" - always self-scan, ignore Composer classmap + # "none" - no proactive scanning, Composer classmap only + strategy = "composer" diff --git a/.prettierignore b/.prettierignore deleted file mode 100755 index 8c1be016..00000000 --- a/.prettierignore +++ /dev/null @@ -1,29 +0,0 @@ -# Tout ce qui est traité par dprint -*.css -*.html -*.js -*.json -!package.json -*.jsonc -*.md -*.scss -*.ts -*.twig -*.yml -*.yaml - -# Tout sauf le thème -.ddev -web/app/* -!web/app/themes -web/app/themes/haiku-atelier-2024/assets -web/app/languages -web/app/plugins -web/vendor - -# Dépendances -composer.lock -pnpm-lock.yaml - -# Jujutsu -.jj diff --git a/.swcrc b/.swcrc deleted file mode 100755 index bd683fb0..00000000 --- a/.swcrc +++ /dev/null @@ -1,31 +0,0 @@ -{ - "$schema": "https://swc.rs/schema.json", - "jsc": { - "externalHelpers": false, - "keepClassNames": false, - "loose": false, - "minify": { - "compress": true, - "mangle": true - }, - "parser": { - "decorators": false, - "decoratorsBeforeExport": false, - "dynamicImport": false, - "exportDefaultFrom": false, - "exportNamespaceFrom": false, - "functionBind": false, - "importMeta": false, - "jsx": false, - "privateMethod": false, - "syntax": "typescript", - "topLevelAwait": false, - "tsx": false - }, - "preserveAllComments": false, - "target": "es2020", - "transform": null - }, - "minify": true, - "sourceMaps": true -} diff --git a/.zed/haa.txt b/.zed/haa.txt deleted file mode 100644 index 922ebbbe..00000000 --- a/.zed/haa.txt +++ /dev/null @@ -1,17 +0,0 @@ -// { -// "languages": { -// "PHP": { -// "format_on_save": "on", -// "formatter": { -// "external": { -// "command": "mago", -// "arguments": ["format", "--stdin-input"] // "command": "bash", -// // "arguments": [ -// // "-c", -// // "cat > /tmp/zed_php_cs_fixer && ./vendor/bin/php-cs-fixer fix --using-cache=no --quiet /tmp/zed_php_cs_fixer && cat /tmp/zed_php_cs_fixer" -// // ] -// } -// } -// } -// } -// } diff --git a/.zed/settings.json b/.zed/settings.json index 0c41da3e..3b8077e7 100644 --- a/.zed/settings.json +++ b/.zed/settings.json @@ -1,17 +1,47 @@ { "language_servers": [ "!biome", + "!cspell", "!deno", + "!eslint", + "!harper-ls", "!intelephense", + "!oxc", + "!oxfmt", + "!oxlint", + "!phptools", "!prettier", "!tailwindcss-language-server", + "!tsgo", "!vtsls", "..." ], - "languages": { - "PHP": { - "format_on_save": "on", - "formatter": { "external": { "command": "mago", "arguments": ["format", "--stdin-input"] } } + "lsp": { + "css-variables": { + "settings": { + "cssVariables": { + "blacklistFolders": [ + "**/*.min.css", + "**/dist/**", + "**/node_modules/**" + ], + "lookupFiles": [ + "**/*.scss" + ], + "undefinedVarFallback": "info" + } + } + }, + "oxlint": { + "initialization_options": { + "settings": { + "configPath": "cfg/oxlint.config.ts", + "disableNestedConfig": false, + "fixKind": "safe_fix", + "run": "onSave", + "unusedDisableDirectives": "deny" + } + } } } } diff --git a/README.md b/README.md index 56765fd8..145aa4c1 100755 --- a/README.md +++ b/README.md @@ -2,6 +2,23 @@ ## Dépendances +### JavaScript et TypeScript + +#### Dépendances + +- Effect +- a11y-dialog +- lit-html + +#### Dépendances de développement + +- ESLint +- Oxlint +- Prettier +- SASS +- Stylelint +- Vite + ### PHP #### Dépendances diff --git a/aube-lock.yaml b/aube-lock.yaml new file mode 100644 index 00000000..3809c4e0 --- /dev/null +++ b/aube-lock.yaml @@ -0,0 +1,6454 @@ +lockfileVersion: '9.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +time: + globals@17.6.0: 2026-05-01T16:37:48.055Z + +importers: + + .: + dependencies: + '@mobily/ts-belt': + specifier: v4.0.0-rc.5 + version: 4.0.0-rc.5 + '@sentry/browser': + specifier: ^10.51.0 + version: 10.51.0 + a11y-dialog: + specifier: ^8.1.5 + version: 8.1.5 + effect: + specifier: ^4.0.0-beta.59 + version: 4.0.0-beta.59 + html-template-tag: + specifier: ^5.0.0 + version: 5.0.0 + lit-html: + specifier: ^3.3.2 + version: 3.3.2 + picomatch: + specifier: ^3 || ^4 + version: 4.0.4 + postcss: + specifier: ^8.4.21 + version: 8.5.12 + purify-ts: + specifier: 2.1.2 + version: 2.1.2 + stylelint-order: + specifier: '>=6' + version: 8.1.1(stylelint@17.9.1) + terser: + specifier: ^5.16.0 + version: 5.46.2 + ts-pattern: + specifier: ^5.9.0 + version: 5.9.0 + valibot: + specifier: 1.1.0 + version: 1.1.0(typescript@6.0.3) + yaml: + specifier: ^2.4.2 + version: 2.8.3 + devDependencies: + '@effect/language-service': + specifier: ^0.85.1 + version: 0.85.1 + '@effect/tsgo': + specifier: ^0.5.2 + version: 0.5.2 + '@gcch/configuration-eslint': + specifier: git+https://git.gcch.fr/gcch/configuration-eslint#888eb4aa54 + version: https://git.gcch.fr/gcch/configuration-eslint#888eb4aa54e5bfd6251566d7469ee99204c19f45 + '@gcch/configuration-oxlint': + specifier: git+https://git.gcch.fr/gcch/configuration-oxlint#83547fc1ebfd + version: https://git.gcch.fr/gcch/configuration-oxlint#83547fc1ebfd6cb402e3c7f074b3e267632ebf4a + '@gcch/configuration-prettier': + specifier: git+https://git.gcch.fr/gcch/configuration-prettier#d267d6dc5e + version: https://git.gcch.fr/gcch/configuration-prettier#d267d6dc5ee8f14378180d71f651009bf7aa3acc + '@playwright/test': + specifier: ^1.59.1 + version: 1.59.1 + '@sentry/core': + specifier: ^10.51.0 + version: 10.51.0 + '@types/bun': + specifier: ^1.3.13 + version: 1.3.13 + '@types/node': + specifier: ^25.6.0 + version: 25.6.0 + '@typescript/native-preview': + specifier: 7.0.0-dev.20260503.1 + version: 7.0.0-dev.20260503.1 + '@vitejs/plugin-legacy': + specifier: ^8.0.1 + version: 8.0.1(terser@5.46.2)(vite@8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3)) + better-typescript-lib: + specifier: ^2.12.0 + version: 2.12.0(typescript@6.0.3) + browserslist: + specifier: ^4.28.2 + version: 4.28.2 + caniuse-lite: + specifier: ^1.0.30001791 + version: 1.0.30001791 + eslint: + specifier: ^10.3.0 + version: 10.3.0(jiti@2.6.1) + eslint-plugin-functional: + specifier: ^9.0.4 + version: 9.0.4(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + eslint-plugin-jsx-a11y: + specifier: ^6.10.2 + version: 6.10.2(eslint@10.3.0(jiti@2.6.1)) + eslint-plugin-oxlint: + specifier: ^1.62.0 + version: 1.62.0(oxlint@1.62.0(oxlint-tsgolint@0.22.1)) + eslint-plugin-perfectionist: + specifier: ^5.9.0 + version: 5.9.0(eslint@10.3.0(jiti@2.6.1)) + fdir: + specifier: ^6.5.0 + version: 6.5.0(picomatch@4.0.4) + globals: + specifier: ^17.6 + version: 17.6.0 + jiti: + specifier: ^2.6.1 + version: 2.6.1 + knip: + specifier: ^6.11.0 + version: 6.11.0 + lightningcss: + specifier: ^1.32.0 + version: 1.32.0 + lightningcss-cli: + specifier: ^1.32.0 + version: 1.32.0 + oxlint: + specifier: ^1.62.0 + version: 1.62.0(oxlint-tsgolint@0.22.1) + oxlint-tsgolint: + specifier: ^0.22.1 + version: 0.22.1 + playwright: + specifier: ^1.59.1 + version: 1.59.1 + prettier: + specifier: ^3.8.3 + version: 3.8.3 + prettier-plugin-curly: + specifier: ^0.4.1 + version: 0.4.1(prettier@3.8.3) + prettier-plugin-ini: + specifier: ^1.3.0 + version: 1.3.0 + prettier-plugin-jsdoc: + specifier: ^1.8.0 + version: 1.8.0(prettier@3.8.3) + prettier-plugin-pkg: + specifier: ^0.22.1 + version: 0.22.1(prettier@3.8.3) + prettier-plugin-sh: + specifier: ^0.18.1 + version: 0.18.1(prettier@3.8.3) + prettier-plugin-sort-json: + specifier: ^4.2.0 + version: 4.2.0(prettier@3.8.3) + sass-embedded: + specifier: ^1.99.0 + version: 1.99.0 + stylelint: + specifier: ^17.9.1 + version: 17.9.1 + stylelint-config-clean-order: + specifier: ^8.0.1 + version: 8.0.1(stylelint@17.9.1)(stylelint-order@8.1.1(stylelint@17.9.1)) + stylelint-config-sass-guidelines: + specifier: ^13.0.0 + version: 13.0.0(postcss@8.5.12)(stylelint@17.9.1) + stylelint-config-standard-scss: + specifier: ^17.0.0 + version: 17.0.0(postcss@8.5.12)(stylelint@17.9.1) + stylelint-declaration-block-no-ignored-properties: + specifier: ^3.0.0 + version: 3.0.0(stylelint@17.9.1) + stylelint-plugin-logical-css: + specifier: ^2.1.0 + version: 2.1.0(stylelint@17.9.1) + typescript: + specifier: ^6.0.3 + version: 6.0.3 + typescript-eslint: + specifier: ^8.59.1 + version: 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + vite: + specifier: ^8.0.10 + version: 8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3) + vite-tsconfig-paths: + specifier: ^6.1.1 + version: 6.1.1(vite@8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3)) + +packages: + + '@astrojs/compiler@3.0.1': + resolution: {integrity: sha512-z97oYbdebO5aoWzuJ/8q5hLK232+17KcLZ7cJ8BCWk6+qNzVxn/gftC0KzMBUTD8WAaBkPpNSQK6PXLnNrZ0CA==} + + '@babel/code-frame@7.29.0': + resolution: {integrity: sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==} + engines: {node: '>=6.9.0'} + + '@babel/compat-data@7.29.0': + resolution: {integrity: sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg==} + engines: {node: '>=6.9.0'} + + '@babel/core@7.29.0': + resolution: {integrity: sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==} + engines: {node: '>=6.9.0'} + + '@babel/generator@7.29.1': + resolution: {integrity: sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw==} + engines: {node: '>=6.9.0'} + + '@babel/helper-annotate-as-pure@7.27.3': + resolution: {integrity: sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg==} + engines: {node: '>=6.9.0'} + + '@babel/helper-compilation-targets@7.28.6': + resolution: {integrity: sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==} + engines: {node: '>=6.9.0'} + + '@babel/helper-create-class-features-plugin@7.28.6': + resolution: {integrity: sha512-dTOdvsjnG3xNT9Y0AUg1wAl38y+4Rl4sf9caSQZOXdNqVn+H+HbbJ4IyyHaIqNR6SW9oJpA/RuRjsjCw2IdIow==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/helper-create-regexp-features-plugin@7.28.5': + resolution: {integrity: sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/helper-define-polyfill-provider@0.6.8': + resolution: {integrity: sha512-47UwBLPpQi1NoWzLuHNjRoHlYXMwIJoBf7MFou6viC/sIHWYygpvr0B6IAyh5sBdA2nr2LPIRww8lfaUVQINBA==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + + '@babel/helper-globals@7.28.0': + resolution: {integrity: sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==} + engines: {node: '>=6.9.0'} + + '@babel/helper-member-expression-to-functions@7.28.5': + resolution: {integrity: sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg==} + engines: {node: '>=6.9.0'} + + '@babel/helper-module-imports@7.28.6': + resolution: {integrity: sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==} + engines: {node: '>=6.9.0'} + + '@babel/helper-module-transforms@7.28.6': + resolution: {integrity: sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/helper-optimise-call-expression@7.27.1': + resolution: {integrity: sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==} + engines: {node: '>=6.9.0'} + + '@babel/helper-plugin-utils@7.28.6': + resolution: {integrity: sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug==} + engines: {node: '>=6.9.0'} + + '@babel/helper-remap-async-to-generator@7.27.1': + resolution: {integrity: sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/helper-replace-supers@7.28.6': + resolution: {integrity: sha512-mq8e+laIk94/yFec3DxSjCRD2Z0TAjhVbEJY3UQrlwVo15Lmt7C2wAUbK4bjnTs4APkwsYLTahXRraQXhb1WCg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/helper-skip-transparent-expression-wrappers@7.27.1': + resolution: {integrity: sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==} + engines: {node: '>=6.9.0'} + + '@babel/helper-string-parser@7.27.1': + resolution: {integrity: sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==} + engines: {node: '>=6.9.0'} + + '@babel/helper-validator-identifier@7.28.5': + resolution: {integrity: sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==} + engines: {node: '>=6.9.0'} + + '@babel/helper-validator-option@7.27.1': + resolution: {integrity: sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==} + engines: {node: '>=6.9.0'} + + '@babel/helper-wrap-function@7.28.6': + resolution: {integrity: sha512-z+PwLziMNBeSQJonizz2AGnndLsP2DeGHIxDAn+wdHOGuo4Fo1x1HBPPXeE9TAOPHNNWQKCSlA2VZyYyyibDnQ==} + engines: {node: '>=6.9.0'} + + '@babel/helpers@7.29.2': + resolution: {integrity: sha512-HoGuUs4sCZNezVEKdVcwqmZN8GoHirLUcLaYVNBK2J0DadGtdcqgr3BCbvH8+XUo4NGjNl3VOtSjEKNzqfFgKw==} + engines: {node: '>=6.9.0'} + + '@babel/parser@7.29.2': + resolution: {integrity: sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA==} + engines: {node: '>=6.0.0'} + hasBin: true + + '@babel/plugin-bugfix-firefox-class-in-computed-class-key@7.28.5': + resolution: {integrity: sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-bugfix-safari-class-field-initializer-scope@7.27.1': + resolution: {integrity: sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@7.27.1': + resolution: {integrity: sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@7.27.1': + resolution: {integrity: sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.13.0 + + '@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@7.28.6': + resolution: {integrity: sha512-a0aBScVTlNaiUe35UtfxAN7A/tehvvG4/ByO6+46VPKTRSlfnAFsgKy0FUh+qAkQrDTmhDkT+IBOKlOoMUxQ0g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2': + resolution: {integrity: sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-syntax-import-assertions@7.28.6': + resolution: {integrity: sha512-pSJUpFHdx9z5nqTSirOCMtYVP2wFgoWhP0p3g8ONK/4IHhLIBd0B9NYqAvIUAhq+OkhO4VM1tENCt0cjlsNShw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-syntax-import-attributes@7.28.6': + resolution: {integrity: sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-syntax-unicode-sets-regex@7.18.6': + resolution: {integrity: sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-transform-arrow-functions@7.27.1': + resolution: {integrity: sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-async-generator-functions@7.29.0': + resolution: {integrity: sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-async-to-generator@7.28.6': + resolution: {integrity: sha512-ilTRcmbuXjsMmcZ3HASTe4caH5Tpo93PkTxF9oG2VZsSWsahydmcEHhix9Ik122RcTnZnUzPbmux4wh1swfv7g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-block-scoped-functions@7.27.1': + resolution: {integrity: sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-block-scoping@7.28.6': + resolution: {integrity: sha512-tt/7wOtBmwHPNMPu7ax4pdPz6shjFrmHDghvNC+FG9Qvj7D6mJcoRQIF5dy4njmxR941l6rgtvfSB2zX3VlUIw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-class-properties@7.28.6': + resolution: {integrity: sha512-dY2wS3I2G7D697VHndN91TJr8/AAfXQNt5ynCTI/MpxMsSzHp+52uNivYT5wCPax3whc47DR8Ba7cmlQMg24bw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-class-static-block@7.28.6': + resolution: {integrity: sha512-rfQ++ghVwTWTqQ7w8qyDxL1XGihjBss4CmTgGRCTAC9RIbhVpyp4fOeZtta0Lbf+dTNIVJer6ych2ibHwkZqsQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.12.0 + + '@babel/plugin-transform-classes@7.28.6': + resolution: {integrity: sha512-EF5KONAqC5zAqT783iMGuM2ZtmEBy+mJMOKl2BCvPZ2lVrwvXnB6o+OBWCS+CoeCCpVRF2sA2RBKUxvT8tQT5Q==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-computed-properties@7.28.6': + resolution: {integrity: sha512-bcc3k0ijhHbc2lEfpFHgx7eYw9KNXqOerKWfzbxEHUGKnS3sz9C4CNL9OiFN1297bDNfUiSO7DaLzbvHQQQ1BQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-destructuring@7.28.5': + resolution: {integrity: sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-dotall-regex@7.28.6': + resolution: {integrity: sha512-SljjowuNKB7q5Oayv4FoPzeB74g3QgLt8IVJw9ADvWy3QnUb/01aw8I4AVv8wYnPvQz2GDDZ/g3GhcNyDBI4Bg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-duplicate-keys@7.27.1': + resolution: {integrity: sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-duplicate-named-capturing-groups-regex@7.29.0': + resolution: {integrity: sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-transform-dynamic-import@7.27.1': + resolution: {integrity: sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-explicit-resource-management@7.28.6': + resolution: {integrity: sha512-Iao5Konzx2b6g7EPqTy40UZbcdXE126tTxVFr/nAIj+WItNxjKSYTEw3RC+A2/ZetmdJsgueL1KhaMCQHkLPIg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-exponentiation-operator@7.28.6': + resolution: {integrity: sha512-WitabqiGjV/vJ0aPOLSFfNY1u9U3R7W36B03r5I2KoNix+a3sOhJ3pKFB3R5It9/UiK78NiO0KE9P21cMhlPkw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-export-namespace-from@7.27.1': + resolution: {integrity: sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-for-of@7.27.1': + resolution: {integrity: sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-function-name@7.27.1': + resolution: {integrity: sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-json-strings@7.28.6': + resolution: {integrity: sha512-Nr+hEN+0geQkzhbdgQVPoqr47lZbm+5fCUmO70722xJZd0Mvb59+33QLImGj6F+DkK3xgDi1YVysP8whD6FQAw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-literals@7.27.1': + resolution: {integrity: sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-logical-assignment-operators@7.28.6': + resolution: {integrity: sha512-+anKKair6gpi8VsM/95kmomGNMD0eLz1NQ8+Pfw5sAwWH9fGYXT50E55ZpV0pHUHWf6IUTWPM+f/7AAff+wr9A==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-member-expression-literals@7.27.1': + resolution: {integrity: sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-modules-amd@7.27.1': + resolution: {integrity: sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-modules-commonjs@7.28.6': + resolution: {integrity: sha512-jppVbf8IV9iWWwWTQIxJMAJCWBuuKx71475wHwYytrRGQ2CWiDvYlADQno3tcYpS/T2UUWFQp3nVtYfK/YBQrA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-modules-systemjs@7.29.0': + resolution: {integrity: sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-modules-umd@7.27.1': + resolution: {integrity: sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-named-capturing-groups-regex@7.29.0': + resolution: {integrity: sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-transform-new-target@7.27.1': + resolution: {integrity: sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-nullish-coalescing-operator@7.28.6': + resolution: {integrity: sha512-3wKbRgmzYbw24mDJXT7N+ADXw8BC/imU9yo9c9X9NKaLF1fW+e5H1U5QjMUBe4Qo4Ox/o++IyUkl1sVCLgevKg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-numeric-separator@7.28.6': + resolution: {integrity: sha512-SJR8hPynj8outz+SlStQSwvziMN4+Bq99it4tMIf5/Caq+3iOc0JtKyse8puvyXkk3eFRIA5ID/XfunGgO5i6w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-object-rest-spread@7.28.6': + resolution: {integrity: sha512-5rh+JR4JBC4pGkXLAcYdLHZjXudVxWMXbB6u6+E9lRL5TrGVbHt1TjxGbZ8CkmYw9zjkB7jutzOROArsqtncEA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-object-super@7.27.1': + resolution: {integrity: sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-optional-catch-binding@7.28.6': + resolution: {integrity: sha512-R8ja/Pyrv0OGAvAXQhSTmWyPJPml+0TMqXlO5w+AsMEiwb2fg3WkOvob7UxFSL3OIttFSGSRFKQsOhJ/X6HQdQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-optional-chaining@7.28.6': + resolution: {integrity: sha512-A4zobikRGJTsX9uqVFdafzGkqD30t26ck2LmOzAuLL8b2x6k3TIqRiT2xVvA9fNmFeTX484VpsdgmKNA0bS23w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-parameters@7.27.7': + resolution: {integrity: sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-private-methods@7.28.6': + resolution: {integrity: sha512-piiuapX9CRv7+0st8lmuUlRSmX6mBcVeNQ1b4AYzJxfCMuBfB0vBXDiGSmm03pKJw1v6cZ8KSeM+oUnM6yAExg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-private-property-in-object@7.28.6': + resolution: {integrity: sha512-b97jvNSOb5+ehyQmBpmhOCiUC5oVK4PMnpRvO7+ymFBoqYjeDHIU9jnrNUuwHOiL9RpGDoKBpSViarV+BU+eVA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-property-literals@7.27.1': + resolution: {integrity: sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-regenerator@7.29.0': + resolution: {integrity: sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-regexp-modifiers@7.28.6': + resolution: {integrity: sha512-QGWAepm9qxpaIs7UM9FvUSnCGlb8Ua1RhyM4/veAxLwt3gMat/LSGrZixyuj4I6+Kn9iwvqCyPTtbdxanYoWYg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/plugin-transform-reserved-words@7.27.1': + resolution: {integrity: sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-shorthand-properties@7.27.1': + resolution: {integrity: sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-spread@7.28.6': + resolution: {integrity: sha512-9U4QObUC0FtJl05AsUcodau/RWDytrU6uKgkxu09mLR9HLDAtUMoPuuskm5huQsoktmsYpI+bGmq+iapDcriKA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-sticky-regex@7.27.1': + resolution: {integrity: sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-template-literals@7.27.1': + resolution: {integrity: sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-typeof-symbol@7.27.1': + resolution: {integrity: sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-unicode-escapes@7.27.1': + resolution: {integrity: sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-unicode-property-regex@7.28.6': + resolution: {integrity: sha512-4Wlbdl/sIZjzi/8St0evF0gEZrgOswVO6aOzqxh1kDZOl9WmLrHq2HtGhnOJZmHZYKP8WZ1MDLCt5DAWwRo57A==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-unicode-regex@7.27.1': + resolution: {integrity: sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/plugin-transform-unicode-sets-regex@7.28.6': + resolution: {integrity: sha512-/wHc/paTUmsDYN7SZkpWxogTOBNnlx7nBQYfy6JJlCT7G3mVhltk3e++N7zV0XfgGsrqBxd4rJQt9H16I21Y1Q==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + + '@babel/preset-env@7.29.2': + resolution: {integrity: sha512-DYD23veRYGvBFhcTY1iUvJnDNpuqNd/BzBwCvzOTKUnJjKg5kpUBh3/u9585Agdkgj+QuygG7jLfOPWMa2KVNw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + + '@babel/preset-modules@0.1.6-no-external-plugins': + resolution: {integrity: sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==} + peerDependencies: + '@babel/core': ^7.0.0-0 || ^8.0.0-0 <8.0.0 + + '@babel/template@7.28.6': + resolution: {integrity: sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==} + engines: {node: '>=6.9.0'} + + '@babel/traverse@7.29.0': + resolution: {integrity: sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==} + engines: {node: '>=6.9.0'} + + '@babel/types@7.29.0': + resolution: {integrity: sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==} + engines: {node: '>=6.9.0'} + + '@bufbuild/protobuf@2.12.0': + resolution: {integrity: sha512-B/XlCaFIP8LOwzo+bz5uFzATYokcwCKQcghqnlfwSmM5eX/qTkvDBnDPs+gXtX/RyjxJ4DRikECcPJbyALA8FA==} + + '@cacheable/memory@2.0.8': + resolution: {integrity: sha512-FvEb29x5wVwu/Kf93IWwsOOEuhHh6dYCJF3vcKLzXc0KXIW181AOzv6ceT4ZpBHDvAfG60eqb+ekmrnLHIy+jw==} + + '@cacheable/utils@2.4.1': + resolution: {integrity: sha512-eiFgzCbIneyMlLOmNG4g9xzF7Hv3Mga4LjxjcSC/ues6VYq2+gUbQI8JqNuw/ZM8tJIeIaBGpswAsqV2V7ApgA==} + + '@csstools/css-calc@3.2.0': + resolution: {integrity: sha512-bR9e6o2BDB12jzN/gIbjHa5wLJ4UjD1CB9pM7ehlc0ddk6EBz+yYS1EV2MF55/HUxrHcB/hehAyt5vhsA3hx7w==} + engines: {node: '>=20.19.0'} + peerDependencies: + '@csstools/css-parser-algorithms': ^4.0.0 + '@csstools/css-tokenizer': ^4.0.0 + + '@csstools/css-parser-algorithms@4.0.0': + resolution: {integrity: sha512-+B87qS7fIG3L5h3qwJ/IFbjoVoOe/bpOdh9hAjXbvx0o8ImEmUsGXN0inFOnk2ChCFgqkkGFQ+TpM5rbhkKe4w==} + engines: {node: '>=20.19.0'} + peerDependencies: + '@csstools/css-tokenizer': ^4.0.0 + + '@csstools/css-syntax-patches-for-csstree@1.1.3': + resolution: {integrity: sha512-SH60bMfrRCJF3morcdk57WklujF4Jr/EsQUzqkarfHXEFcAR1gg7fS/chAE922Sehgzc1/+Tz5H3Ypa1HiEKrg==} + peerDependencies: + css-tree: ^3.2.1 + peerDependenciesMeta: + css-tree: + optional: true + + '@csstools/css-tokenizer@4.0.0': + resolution: {integrity: sha512-QxULHAm7cNu72w97JUNCBFODFaXpbDg+dP8b/oWFAZ2MTRppA3U00Y2L1HqaS4J6yBqxwa/Y3nMBaxVKbB/NsA==} + engines: {node: '>=20.19.0'} + + '@csstools/media-query-list-parser@5.0.0': + resolution: {integrity: sha512-T9lXmZOfnam3eMERPsszjY5NK0jX8RmThmmm99FZ8b7z8yMaFZWKwLWGZuTwdO3ddRY5fy13GmmEYZXB4I98Eg==} + engines: {node: '>=20.19.0'} + peerDependencies: + '@csstools/css-parser-algorithms': ^4.0.0 + '@csstools/css-tokenizer': ^4.0.0 + + '@csstools/selector-resolve-nested@4.0.0': + resolution: {integrity: sha512-9vAPxmp+Dx3wQBIUwc1v7Mdisw1kbbaGqXUM8QLTgWg7SoPGYtXBsMXvsFs/0Bn5yoFhcktzxNZGNaUt0VjgjA==} + engines: {node: '>=20.19.0'} + peerDependencies: + postcss-selector-parser: ^7.1.1 + + '@csstools/selector-specificity@6.0.0': + resolution: {integrity: sha512-4sSgl78OtOXEX/2d++8A83zHNTgwCJMaR24FvsYL7Uf/VS8HZk9PTwR51elTbGqMuwH3szLvvOXEaVnqn0Z3zA==} + engines: {node: '>=20.19.0'} + peerDependencies: + postcss-selector-parser: ^7.1.1 + + '@effect/language-service@0.85.1': + resolution: {integrity: sha512-EXnJjIy6zQ3nUO/MZ+ynWUb8B895KZPotd1++oTs9JjDkplwM7cb6zo8Zq2zU6piwq+KflO7amXbEfj1UMpHkw==} + hasBin: true + + '@effect/tsgo-linux-x64@0.5.2': + resolution: {integrity: sha512-V6sHIZlKQv693ABb9REX0RzIvzyCbNg2uP5+4MXwetlSxz8pmeAUCpraAQLXBkKlYL5rG9kMIobDFU9A88Nqig==} + os: + - linux + cpu: + - x64 + + '@effect/tsgo@0.5.2': + resolution: {integrity: sha512-LEKmx1rwP1j3l9mPW6Bx8VIdGKW+uEvvML89z4xiWnPC+h/uFm3y6FGHULop9Kl09Ybwn2TVuZzVPSZLj+ydmg==} + hasBin: true + + '@es-joy/jsdoccomment@0.86.0': + resolution: {integrity: sha512-ukZmRQ81WiTpDWO6D/cTBM7XbrNtutHKvAVnZN/8pldAwLoJArGOvkNyxPTBGsPjsoaQBJxlH+tE2TNA/92Qgw==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + '@es-joy/resolve.exports@1.2.0': + resolution: {integrity: sha512-Q9hjxWI5xBM+qW2enxfe8wDKdFWMfd0Z29k5ZJnuBqD/CasY5Zryj09aCA6owbGATWz+39p5uIdaHXpopOcG8g==} + engines: {node: '>=10'} + + '@eslint-community/eslint-utils@4.9.1': + resolution: {integrity: sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + peerDependencies: + eslint: ^6.0.0 || ^7.0.0 || >=8.0.0 + + '@eslint-community/regexpp@4.12.2': + resolution: {integrity: sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew==} + engines: {node: ^12.0.0 || ^14.0.0 || >=16.0.0} + + '@eslint/config-array@0.23.5': + resolution: {integrity: sha512-Y3kKLvC1dvTOT+oGlqNQ1XLqK6D1HU2YXPc52NmAlJZbMMWDzGYXMiPRJ8TYD39muD/OTjlZmNJ4ib7dvSrMBA==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + '@eslint/config-helpers@0.5.5': + resolution: {integrity: sha512-eIJYKTCECbP/nsKaaruF6LW967mtbQbsw4JTtSVkUQc9MneSkbrgPJAbKl9nWr0ZeowV8BfsarBmPpBzGelA2w==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + '@eslint/core@1.2.1': + resolution: {integrity: sha512-MwcE1P+AZ4C6DWlpin/OmOA54mmIZ/+xZuJiQd4SyB29oAJjN30UW9wkKNptW2ctp4cEsvhlLY/CsQ1uoHDloQ==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + '@eslint/js@10.0.1': + resolution: {integrity: sha512-zeR9k5pd4gxjZ0abRoIaxdc7I3nDktoXZk2qOv9gCNWx3mVwEn32VRhyLaRsDiJjTs0xq/T8mfPtyuXu7GWBcA==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + peerDependencies: + eslint: ^10.0.0 + peerDependenciesMeta: + eslint: + optional: true + + '@eslint/object-schema@3.0.5': + resolution: {integrity: sha512-vqTaUEgxzm+YDSdElad6PiRoX4t8VGDjCtt05zn4nU810UIx/uNEV7/lZJ6KwFThKZOzOxzXy48da+No7HZaMw==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + '@eslint/plugin-kit@0.7.1': + resolution: {integrity: sha512-rZAP3aVgB9ds9KOeUSL+zZ21hPmo8dh6fnIFwRQj5EAZl9gzR7wxYbYXYysAM8CTqGmUGyp2S4kUdV17MnGuWQ==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + '@gcch/configuration-eslint@https://git.gcch.fr/gcch/configuration-eslint#888eb4aa54e5bfd6251566d7469ee99204c19f45': + resolution: {commit: 888eb4aa54e5bfd6251566d7469ee99204c19f45, repo: https://git.gcch.fr/gcch/configuration-eslint, type: git} + + '@gcch/configuration-oxlint@https://git.gcch.fr/gcch/configuration-oxlint#83547fc1ebfd6cb402e3c7f074b3e267632ebf4a': + resolution: {commit: 83547fc1ebfd6cb402e3c7f074b3e267632ebf4a, repo: https://git.gcch.fr/gcch/configuration-oxlint, type: git} + + '@gcch/configuration-prettier@https://git.gcch.fr/gcch/configuration-prettier#d267d6dc5ee8f14378180d71f651009bf7aa3acc': + resolution: {commit: d267d6dc5ee8f14378180d71f651009bf7aa3acc, repo: https://git.gcch.fr/gcch/configuration-prettier, type: git} + + '@humanfs/core@0.19.2': + resolution: {integrity: sha512-UhXNm+CFMWcbChXywFwkmhqjs3PRCmcSa/hfBgLIb7oQ5HNb1wS0icWsGtSAUNgefHeI+eBrA8I1fxmbHsGdvA==} + engines: {node: '>=18.18.0'} + + '@humanfs/node@0.16.8': + resolution: {integrity: sha512-gE1eQNZ3R++kTzFUpdGlpmy8kDZD/MLyHqDwqjkVQI0JMdI1D51sy1H958PNXYkM2rAac7e5/CnIKZrHtPh3BQ==} + engines: {node: '>=18.18.0'} + + '@humanfs/types@0.15.0': + resolution: {integrity: sha512-ZZ1w0aoQkwuUuC7Yf+7sdeaNfqQiiLcSRbfI08oAxqLtpXQr9AIVX7Ay7HLDuiLYAaFPu8oBYNq/QIi9URHJ3Q==} + engines: {node: '>=18.18.0'} + + '@humanwhocodes/module-importer@1.0.1': + resolution: {integrity: sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==} + engines: {node: '>=12.22'} + + '@humanwhocodes/retry@0.4.3': + resolution: {integrity: sha512-bV0Tgo9K4hfPCek+aMAn81RppFKv2ySDQeMoSZuvTASywNTnVJCArCZE2FWqpvIatKu7VMRLWlR1EazvVhDyhQ==} + engines: {node: '>=18.18'} + + '@jridgewell/gen-mapping@0.3.13': + resolution: {integrity: sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==} + + '@jridgewell/remapping@2.3.5': + resolution: {integrity: sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==} + + '@jridgewell/resolve-uri@3.1.2': + resolution: {integrity: sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==} + engines: {node: '>=6.0.0'} + + '@jridgewell/source-map@0.3.11': + resolution: {integrity: sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA==} + + '@jridgewell/sourcemap-codec@1.5.5': + resolution: {integrity: sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==} + + '@jridgewell/trace-mapping@0.3.31': + resolution: {integrity: sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==} + + '@keyv/bigmap@1.3.1': + resolution: {integrity: sha512-WbzE9sdmQtKy8vrNPa9BRnwZh5UF4s1KTmSK0KUVLo3eff5BlQNNWDnFOouNpKfPKDnms9xynJjsMYjMaT/aFQ==} + engines: {node: '>= 18'} + peerDependencies: + keyv: ^5.6.0 + + '@keyv/serialize@1.1.1': + resolution: {integrity: sha512-dXn3FZhPv0US+7dtJsIi2R+c7qWYiReoEh5zUntWCf4oSpMNib8FDhSoed6m3QyZdx5hK7iLFkYk3rNxwt8vTA==} + + '@mobily/ts-belt@4.0.0-rc.5': + resolution: {integrity: sha512-HLWJ8yKrfwdMzCvckRunrAL8Z+K5q31FdY6JzhkBp8o6uQsVuzf26KFyno1s6n6GB78OJEsjs57SaDk9plsJhA==} + engines: {node: '>= 10.*'} + + '@msgpackr-extract/msgpackr-extract-linux-x64@3.0.3': + resolution: {integrity: sha512-cvwNfbP07pKUfq1uH+S6KJ7dT9K8WOE4ZiAcsrSes+UY55E/0jLYc+vq+DO7jlmqRb5zAggExKm0H7O/CBaesg==} + os: + - linux + cpu: + - x64 + + '@nodelib/fs.scandir@2.1.5': + resolution: {integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==} + engines: {node: '>= 8'} + + '@nodelib/fs.stat@2.0.5': + resolution: {integrity: sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==} + engines: {node: '>= 8'} + + '@nodelib/fs.walk@1.2.8': + resolution: {integrity: sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==} + engines: {node: '>= 8'} + + '@oxc-parser/binding-linux-x64-gnu@0.128.0': + resolution: {integrity: sha512-OO1nW2Q7sSYYvJZpDHdvyFSdRaVcQqRijZSSmWVMqFxPYy8cEF45zJ9fcdIYuzIT3jYq6YRhEFm/VMWNWhE22Q==} + engines: {node: ^20.19.0 || >=22.12.0} + os: + - linux + cpu: + - x64 + + '@oxc-parser/binding-linux-x64-musl@0.128.0': + resolution: {integrity: sha512-4NehAe404MRdoZVS9DW8C5XbJwbXIc/KfVlYdpi5vE4081zc9Y0YzKVqyOYj/Puye7/Do+ohaONBFWlEHYl9hw==} + engines: {node: ^20.19.0 || >=22.12.0} + os: + - linux + cpu: + - x64 + + '@oxc-project/types@0.127.0': + resolution: {integrity: sha512-aIYXQBo4lCbO4z0R3FHeucQHpF46l2LbMdxRvqvuRuW2OxdnSkcng5B8+K12spgLDj93rtN3+J2Vac/TIO+ciQ==} + + '@oxc-project/types@0.128.0': + resolution: {integrity: sha512-huv1Y/LzBJkBVHt3OlC7u0zHBW9qXf1FdD7sGmc1rXc2P1mTwHssYv7jyGx5KAACSCH+9B3Bhn6Z9luHRvf7pQ==} + + '@oxc-resolver/binding-linux-x64-gnu@11.19.1': + resolution: {integrity: sha512-NxjZe+rqWhr+RT8/Ik+5ptA3oz7tUw361Wa5RWQXKnfqwSSHdHyrw6IdcTfYuml9dM856AlKWZIUXDmA9kkiBQ==} + os: + - linux + cpu: + - x64 + + '@oxc-resolver/binding-linux-x64-musl@11.19.1': + resolution: {integrity: sha512-cM/hQwsO3ReJg5kR+SpI69DMfvNCp+A/eVR4b4YClE5bVZwz8rh2Nh05InhwI5HR/9cArbEkzMjcKgTHS6UaNw==} + os: + - linux + cpu: + - x64 + + '@oxlint-tsgolint/linux-x64@0.22.1': + resolution: {integrity: sha512-fuX1hEQfpHauUbXADsfqVhRzrUrGabzGXbj5wsp2vKhV5uk/Rze8Mba9GdjFGECzvXudMGqHqxB4r6jGRdhxVA==} + os: + - linux + cpu: + - x64 + + '@oxlint/binding-linux-x64-gnu@1.62.0': + resolution: {integrity: sha512-5z25jcAA0gfKyVwz71A0VXgaPlocPoTAxhlv/hgoK6tlCrfoNuw7haWbDHvGMfjXhdic4EqVXGRv5XsTqFnbRQ==} + engines: {node: ^20.19.0 || >=22.12.0} + os: + - linux + cpu: + - x64 + + '@oxlint/binding-linux-x64-musl@1.62.0': + resolution: {integrity: sha512-IWpHmMB6ZDllPvqWDkG6AmXrN7JF5e/c4g/0PuURsmlK+vHoYZPB70rr4u1bn3I4LsKCSpqqfveyx6UCOC8wdg==} + engines: {node: ^20.19.0 || >=22.12.0} + os: + - linux + cpu: + - x64 + + '@pkgr/core@0.2.9': + resolution: {integrity: sha512-QNqXyfVS2wm9hweSYD2O7F0G06uurj9kZ96TRQE5Y9hU7+tgdZwIkbAKc5Ocy1HxEY2kuDQa6cQ1WRs/O5LFKA==} + engines: {node: ^12.20.0 || ^14.18.0 || >=16.0.0} + + '@playwright/test@1.59.1': + resolution: {integrity: sha512-PG6q63nQg5c9rIi4/Z5lR5IVF7yU5MqmKaPOe0HSc0O2cX1fPi96sUQu5j7eo4gKCkB2AnNGoWt7y4/Xx3Kcqg==} + engines: {node: '>=18'} + hasBin: true + + '@reteps/dockerfmt@0.5.2': + resolution: {integrity: sha512-Hbr7yen4fP5TxGM54ucXa4o5NwWXatJ6Bd9I8gp0PValYbI4Rug2Gu+rVv7K7o/efQc3F5ctqWJz47rYaa8zBw==} + engines: {node: ^v12.20.0 || ^14.13.0 || >=16.0.0} + + '@rolldown/binding-linux-x64-gnu@1.0.0-rc.17': + resolution: {integrity: sha512-cLnjV3xfo7KslbU41Z7z8BH/E1y5mzUYzAqih1d1MDaIGZRCMqTijqLv76/P7fyHuvUcfGsIpqCdddbxLLK9rA==} + engines: {node: ^20.19.0 || >=22.12.0} + os: + - linux + cpu: + - x64 + + '@rolldown/binding-linux-x64-musl@1.0.0-rc.17': + resolution: {integrity: sha512-0phclDw1spsL7dUB37sIARuis2tAgomCJXAHZlpt8PXZ4Ba0dRP1e+66lsRqrfhISeN9bEGNjQs+T/Fbd7oYGw==} + engines: {node: ^20.19.0 || >=22.12.0} + os: + - linux + cpu: + - x64 + + '@rolldown/pluginutils@1.0.0-rc.17': + resolution: {integrity: sha512-n8iosDOt6Ig1UhJ2AYqoIhHWh/isz0xpicHTzpKBeotdVsTEcxsSA/i3EVM7gQAj0rU27OLAxCjzlj15IWY7bg==} + + '@sentry-internal/browser-utils@10.51.0': + resolution: {integrity: sha512-lNKBS4P7RUvf1niojXQWe9bU3gnBUCbST4Dj0pSiyat1N96cXVyHkeE+uGxowD0RrVWhs+kGHiVX3FcmRWF6sA==} + engines: {node: '>=18'} + + '@sentry-internal/feedback@10.51.0': + resolution: {integrity: sha512-bCM95bcpphx28e6aU0bwRLxOgwosYsdNzezM1sM0pVOkb0TB3hDFRamramVDK+/Hp1o8qmRxS4c5w/A7YBZGkA==} + engines: {node: '>=18'} + + '@sentry-internal/replay-canvas@10.51.0': + resolution: {integrity: sha512-8PW1Pp+Yl3lPwYqhBCr5SgkuhDanu9ZLzUqD2bPKL/ElqbM2eDVIWxq4z4ZzePrmZa6IcCjTv6sVQJ7Z4dLyLA==} + engines: {node: '>=18'} + + '@sentry-internal/replay@10.51.0': + resolution: {integrity: sha512-jCpI5HXSwK6ZT2HX70+mDRciAocHzSiDk4DTgvzV69Wvd+Ei5WLgE+d39eaEPsm8lUC0Ydntb5sJIB6uG9D4bw==} + engines: {node: '>=18'} + + '@sentry/browser@10.51.0': + resolution: {integrity: sha512-Zdc0sKfenxUtW/OGhtJ7xHFN44bXR7YqxJ1zBDzlZfW0nTbeTTUZBq9z5NUw6qdS0Vs/i3V4qzAKTbRKWfqSEA==} + engines: {node: '>=18'} + + '@sentry/core@10.51.0': + resolution: {integrity: sha512-Y45V/YXvVLEXmOdkbD1oG1gkRWFi9guCEGg3PlIlIpRjAbZUrvLGgjRJIc1E7XpSzmOnWbs5BbUxMv4PDaPj2w==} + engines: {node: '>=18'} + + '@sindresorhus/base62@1.0.0': + resolution: {integrity: sha512-TeheYy0ILzBEI/CO55CP6zJCSdSWeRtGnHy8U8dWSUH4I68iqTsy7HkMktR4xakThc9jotkPQUXT4ITdbV7cHA==} + engines: {node: '>=18'} + + '@sindresorhus/merge-streams@4.0.0': + resolution: {integrity: sha512-tlqY9xq5ukxTUZBmoOp+m61cqwQD5pHJtFY3Mn8CA8ps6yghLH/Hw8UPdqg4OLmFW3IFlcXnQNmo/dh8HzXYIQ==} + engines: {node: '>=18'} + + '@standard-schema/spec@1.1.0': + resolution: {integrity: sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==} + + '@stylistic/stylelint-plugin@5.1.0': + resolution: {integrity: sha512-TFvKCbJUEWUYCD+rDv45qhnStO6nRtbBngaCblS2JGh8c95S3jJi3fIotfF6EDo4IVM15UPa65WP+kp6GNvXRA==} + engines: {node: '>=20.19.0'} + peerDependencies: + stylelint: ^17.6.0 + + '@types/bun@1.3.13': + resolution: {integrity: sha512-9fqXWk5YIHGGnUau9TEi+qdlTYDAnOj+xLCmSTwXfAIqXr2x4tytJb43E9uCvt09zJURKXwAtkoH4nLQfzeTXw==} + + '@types/debug@4.1.13': + resolution: {integrity: sha512-KSVgmQmzMwPlmtljOomayoR89W4FynCAi3E8PPs7vmDVPe84hT+vGPKkJfThkmXs0x0jAaa9U8uW8bbfyS2fWw==} + + '@types/esrecurse@4.3.1': + resolution: {integrity: sha512-xJBAbDifo5hpffDBuHl0Y8ywswbiAp/Wi7Y/GtAgSlZyIABppyurxVueOPE8LUQOxdlgi6Zqce7uoEpqNTeiUw==} + + '@types/estree@1.0.8': + resolution: {integrity: sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==} + + '@types/json-schema@7.0.15': + resolution: {integrity: sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==} + + '@types/mdast@4.0.4': + resolution: {integrity: sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==} + + '@types/ms@2.1.0': + resolution: {integrity: sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==} + + '@types/node@25.6.0': + resolution: {integrity: sha512-+qIYRKdNYJwY3vRCZMdJbPLJAtGjQBudzZzdzwQYkEPQd+PJGixUL5QfvCLDaULoLv+RhT3LDkwEfKaAkgSmNQ==} + + '@types/trusted-types@2.0.7': + resolution: {integrity: sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==} + + '@types/unist@3.0.3': + resolution: {integrity: sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==} + + '@typescript-eslint/eslint-plugin@8.59.1': + resolution: {integrity: sha512-BOziFIfE+6osHO9FoJG4zjoHUcvI7fTNBSpdAwrNH0/TLvzjsk2oo8XSSOT2HhqUyhZPfHv4UOffoJ9oEEQ7Ag==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + '@typescript-eslint/parser': ^8.59.1 + eslint: ^8.57.0 || ^9.0.0 || ^10.0.0 + typescript: '>=4.8.4 <6.1.0' + + '@typescript-eslint/parser@8.59.1': + resolution: {integrity: sha512-HDQH9O/47Dxi1ceDhBXdaldtf/WV9yRYMjbjCuNk3qnaTD564qwv61Y7+gTxwxRKzSrgO5uhtw584igXVuuZkA==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + eslint: ^8.57.0 || ^9.0.0 || ^10.0.0 + typescript: '>=4.8.4 <6.1.0' + + '@typescript-eslint/project-service@8.59.1': + resolution: {integrity: sha512-+MuHQlHiEr00Of/IQbE/MmEoi44znZHbR/Pz7Opq4HryUOlRi+/44dro9Ycy8Fyo+/024IWtw8m4JUMCGTYxDg==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + typescript: '>=4.8.4 <6.1.0' + + '@typescript-eslint/scope-manager@8.59.1': + resolution: {integrity: sha512-LwuHQI4pDOYVKvmH2dkaJo6YZCSgouVgnS/z7yBPKBMvgtBvyLqiLy9Z6b7+m/TRcX1NFYUqZetI5Y+aT4GEfg==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + '@typescript-eslint/tsconfig-utils@8.59.1': + resolution: {integrity: sha512-/0nEyPbX7gRsk0Uwfe4ALwwgxuA66d/l2mhRDNlAvaj4U3juhUtJNq0DsY8M2AYwwb9rEq2hrC3IcIcEt++iJA==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + typescript: '>=4.8.4 <6.1.0' + + '@typescript-eslint/type-utils@8.59.1': + resolution: {integrity: sha512-klWPBR2ciQHS3f++ug/mVnWKPjBUo7icEL3FAO1lhAR1Z1i5NQYZ1EannMSRYcq5qCv5wNALlXr6fksRHyYl7w==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + eslint: ^8.57.0 || ^9.0.0 || ^10.0.0 + typescript: '>=4.8.4 <6.1.0' + + '@typescript-eslint/types@8.59.1': + resolution: {integrity: sha512-ZDCjgccSdYPw5Bxh+my4Z0lJU96ZDN7jbBzvmEn0FZx3RtU1C7VWl6NbDx94bwY3V5YsgwRzJPOgeY2Q/nLG8A==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + '@typescript-eslint/typescript-estree@8.59.1': + resolution: {integrity: sha512-OUd+vJS05sSkOip+BkZ/2NS8RMxrAAJemsC6vU3kmfLyeaJT0TftHkV9mcx2107MmsBVXXexhVu4F0TZXyMl4g==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + typescript: '>=4.8.4 <6.1.0' + + '@typescript-eslint/utils@8.59.1': + resolution: {integrity: sha512-3pIeoXhCeYH9FSCBI8P3iNwJlGuzPlYKkTlen2O9T1DSeeg8UG8jstq6BLk+Mda0qup7mgk4z4XL4OzRaxZ8LA==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + eslint: ^8.57.0 || ^9.0.0 || ^10.0.0 + typescript: '>=4.8.4 <6.1.0' + + '@typescript-eslint/visitor-keys@8.59.1': + resolution: {integrity: sha512-LdDNl6C5iJExcM0Yh0PwAIBb9PrSiCsWamF/JyEZawm3kFDnRoaq3LGE4bpyRao/fWeGKKyw7icx0YxrLFC5Cg==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + '@typescript/lib-decorators@2.12.0': + resolution: {integrity: sha512-/m9Q5Xk66ThUJidTsxmXJH0+49iCLl5PFmue0HkNSGrcPU96oaoKNY5sH1AslwA/OWVvBg3hE58ZwSGm6TQFuQ==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/decorators' + + '@typescript/lib-dom@2.12.0': + resolution: {integrity: sha512-via7EW6RKBeUcE9JBS3lNoQeCfghGZoRhBMXOsgOyvBskTdP45MUi6hM7RZMYbTcOh2tzg3j70uhe+1MajCJXw==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/dom' + + '@typescript/lib-es2015@2.12.0': + resolution: {integrity: sha512-woXTAKb6yUSdy8hm2NQPnvvE0PVQeFLp1rfHrwHlFF/5vG9EjltI9+jdaSN2jtS5sW8SeSQiKCtIZ/AYK/YxQA==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2015' + + '@typescript/lib-es2016@2.12.0': + resolution: {integrity: sha512-8V5jFi+qpJbop+xdSEX7PtA6KxUzNXxoN3Lt5MrUB3TLpb/vh6uzphQmYULnkcn1ScdXTzbpHwG4rdNFY36wTA==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2016' + + '@typescript/lib-es2017@2.12.0': + resolution: {integrity: sha512-iCUQOIylZwFt+NrkH0LTYzc+LmqRpLkDGLR7zvZs4PlgjONjyYcbyYar2LVbX3XcBsnx7vVW7andI4+aXb+AZQ==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2017' + + '@typescript/lib-es2018@2.12.0': + resolution: {integrity: sha512-mch+ACDNKYI8rKBM2AeebejyoI0cK3lpmc7m1yMoPzDOronjGk5sLYryCheLWXeMhUguO13tN5RnlJDyhV1E1A==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2018' + + '@typescript/lib-es2019@2.12.0': + resolution: {integrity: sha512-x/+BqehInEYoILfItuHXJdX6hLEOHAUhNlN/x99uN48o6HCKi4teoOaUWlxclcPeS2LmlE4RLzXUylEvd+DPtQ==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2019' + + '@typescript/lib-es2020@2.12.0': + resolution: {integrity: sha512-Kc5OPXfLwYnkS+Oa4h8+iPYNdktxMvOum/cW/5WHU4UTtgmShceahbc/9dDsp04fvgTGiT47KHEMuxQYdbx/mQ==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2020' + + '@typescript/lib-es2021@2.12.0': + resolution: {integrity: sha512-oc9FxQuHPLYoiNPo0oAAm5PRQEuoLJ39BI1e2jaPLfC1zdc5QbMk517NfKmNb4enlUGKoOhC3uSrpS/OjkSPWw==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2021' + + '@typescript/lib-es2022@2.12.0': + resolution: {integrity: sha512-MnqVGp9hmwnCDXv7O8V50rynt+4CU9fPTx2EJ39r0PibzW1dKT7bLdlFNS0+hDFLkJZlV2kgoctP3e5wEBLu7w==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2022' + + '@typescript/lib-es2023@2.12.0': + resolution: {integrity: sha512-rB7pbtaxNy9ReKV22lfXfXCfQFCdtxbas+oxcjiTNRYkCcSgc5B3nA3v+NQcbNk1MukhnQca7bmw2tqvKaV8OQ==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2023' + + '@typescript/lib-es2024@2.12.0': + resolution: {integrity: sha512-zNCgAaV0hFW1SNeEfvjO7EX35w+Ja16PRP4TFL7ZyENcs93mghQEH9l437Pixya+sG3a2m7GbkFjzv+Z6Bkf5w==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es2024' + + '@typescript/lib-es5@2.12.0': + resolution: {integrity: sha512-TueHgCcwn6QX8MFzC/kx6p7Y9AJUDIwsRz4klOSxGU3l0oUnqSv0uYOrZuLOldeVuVHHfKHKP11I5ELVmWQSNg==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es5' + + '@typescript/lib-es6@2.12.0': + resolution: {integrity: sha512-zBPoQsg5a1pc2Um5udWadmJRPtH3wR6Z7PMk4q1vQnAn5N3RyzKcvFvNqiQWQXIl0ptSaKN4IVxMzJ+OKi9dUg==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/es6' + + '@typescript/lib-esnext@2.12.0': + resolution: {integrity: sha512-fOBovlfESsE6bHG8ITAvW3o5qQztryc+8onzRRpDS8gZCOjWX7eNoeM8FlMHplEgWfL0FknKh/o1y7xDXRYhLA==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/esnext' + + '@typescript/lib-scripthost@2.12.0': + resolution: {integrity: sha512-B5Fz5HARk9G7ntuRawvT+VMwdhN/+OUIuBRW+7IBq3Jk8lzwu53aLSmKK38suGpPikfVhaC1EmA8nPcgHFMlCQ==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/scripthost' + + '@typescript/lib-webworker@2.12.0': + resolution: {integrity: sha512-YktWJCUYdrRORhd4NgnPZCEzElDglPZzVnfkxGNmEhPpFE1W6ThKDQqkvMZapf3T+0xGeDqJx9V4xhFNnv56Xw==} + peerDependencies: + typescript: '>=4.5.2' + aliasOf: '@better-typescript-lib/webworker' + + '@typescript/native-preview-linux-x64@7.0.0-dev.20260503.1': + resolution: {integrity: sha512-M64z7LwpqNfOXYCBKmD/ObwyxYOobUk4tDv0ECNLit7pDER1sswNZjJGjgRYjQsKokmydy6p3FqtJ1uUPUP/sw==} + engines: {node: '>=16.20.0'} + os: + - linux + cpu: + - x64 + + '@typescript/native-preview@7.0.0-dev.20260503.1': + resolution: {integrity: sha512-gDro38CPFiBUGbaFGNt+ufOsEd1OrZrfrOPxsLSfBcvvoGaqAxV++ul/BHTOShoEkIYHiFsoDX2az1IPCDV2jQ==} + engines: {node: '>=16.20.0'} + hasBin: true + + '@vitejs/plugin-legacy@8.0.1': + resolution: {integrity: sha512-8zeDeuNPqXd49rIVgFgluQYB8vQICHR7l+W2I3CxYK4gTjTorajVr0wLvSjALIwEwLRxBn68EgNVyGP4j6hP7w==} + engines: {node: ^20.19.0 || >=22.12.0} + peerDependencies: + terser: ^5.16.0 + vite: ^8.0.0 + + a11y-dialog@8.1.5: + resolution: {integrity: sha512-SlFk3QSqeuvmN/anaIteUkB6ipBHoG1jq5gfQZU2kqvbkDW3Iab7SNufj4io4e8StvuIshD+loJnsQgTEvq6dA==} + + acorn-jsx@5.3.2: + resolution: {integrity: sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==} + peerDependencies: + acorn: ^6.0.0 || ^7.0.0 || ^8.0.0 + + acorn@8.16.0: + resolution: {integrity: sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==} + engines: {node: '>=0.4.0'} + hasBin: true + + ajv@6.15.0: + resolution: {integrity: sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==} + + ajv@8.20.0: + resolution: {integrity: sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==} + + ansi-regex@5.0.1: + resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==} + engines: {node: '>=8'} + + ansi-regex@6.2.2: + resolution: {integrity: sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==} + engines: {node: '>=12'} + + ansi-styles@4.3.0: + resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==} + engines: {node: '>=8'} + + are-docs-informative@0.0.2: + resolution: {integrity: sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==} + engines: {node: '>=14'} + + argparse@2.0.1: + resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==} + + aria-query@5.3.2: + resolution: {integrity: sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==} + engines: {node: '>= 0.4'} + + array-buffer-byte-length@1.0.2: + resolution: {integrity: sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==} + engines: {node: '>= 0.4'} + + array-includes@3.1.9: + resolution: {integrity: sha512-FmeCCAenzH0KH381SPT5FZmiA/TmpndpcaShhfgEN9eCVjnFBqq3l1xrI42y8+PPLI6hypzou4GXw00WHmPBLQ==} + engines: {node: '>= 0.4'} + + array.prototype.flat@1.3.3: + resolution: {integrity: sha512-rwG/ja1neyLqCuGZ5YYrznA62D4mZXg0i1cIskIUKSiqF3Cje9/wXAls9B9s1Wa2fomMsIv8czB8jZcPmxCXFg==} + engines: {node: '>= 0.4'} + + array.prototype.flatmap@1.3.3: + resolution: {integrity: sha512-Y7Wt51eKJSyi80hFrJCePGGNo5ktJCslFuboqJsbf57CCPcm5zztluPlc4/aD8sWsKvlwatezpV4U1efk8kpjg==} + engines: {node: '>= 0.4'} + + arraybuffer.prototype.slice@1.0.4: + resolution: {integrity: sha512-BNoCY6SXXPQ7gF2opIP4GBE+Xw7U+pHMYKuzjgCN3GwiaIR09UUeKfheyIry77QtrCBlC0KK0q5/TER/tYh3PQ==} + engines: {node: '>= 0.4'} + + ast-types-flow@0.0.8: + resolution: {integrity: sha512-OH/2E5Fg20h2aPrbe+QL8JZQFko0YZaF+j4mnQ7BGhfavO7OpSLa8a0y9sBwomHdSbkhTS8TQNayBfnW5DwbvQ==} + + astral-regex@2.0.0: + resolution: {integrity: sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==} + engines: {node: '>=8'} + + astro-eslint-parser@1.4.0: + resolution: {integrity: sha512-+QDcgc7e+au6EZ0YjMmRRjNoQo5bDMlaR45aWDoFsuxQTCM9qmCHRoiKJPELgckJ8Wmr7vcfpa9eCDHBFh6G4w==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + astrojs-compiler-sync@1.1.1: + resolution: {integrity: sha512-0mKvB9sDQRIZPsEJadw6OaFbGJ92cJPPR++ICca9XEyiUAZqgVuk25jNmzHPT0KF80rI94trSZrUR5iHFXGGOQ==} + engines: {node: ^18.18.0 || >=20.9.0} + peerDependencies: + '@astrojs/compiler': '>=0.27.0' + + async-function@1.0.0: + resolution: {integrity: sha512-hsU18Ae8CDTR6Kgu9DYf0EbCr/a5iGL0rytQDobUcdpYOKokk8LEjVphnXkDkgpi0wYVsqrXuP0bZxJaTqdgoA==} + engines: {node: '>= 0.4'} + + async-generator-function@1.0.0: + resolution: {integrity: sha512-+NAXNqgCrB95ya4Sr66i1CL2hqLVckAk7xwRYWdcm39/ELQ6YNn1aw5r0bdQtqNZgQpEWzc5yc/igXc7aL5SLA==} + engines: {node: '>= 0.4'} + + available-typed-arrays@1.0.7: + resolution: {integrity: sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==} + engines: {node: '>= 0.4'} + + axe-core@4.11.3: + resolution: {integrity: sha512-zBQouZixDTbo3jMGqHKyePxYxr1e5W8UdTmBQ7sNtaA9M2bE32daxxPLS/jojhKOHxQ7LWwPjfiwf/fhaJWzlg==} + engines: {node: '>=4'} + + axobject-query@4.1.0: + resolution: {integrity: sha512-qIj0G9wZbMGNLjLmg1PT6v2mE9AH2zlnADJD/2tC6E00hgmhUOfEB6greHPAfLRSufHqROIUTkw6E+M3lH0PTQ==} + engines: {node: '>= 0.4'} + + babel-plugin-polyfill-corejs2@0.4.17: + resolution: {integrity: sha512-aTyf30K/rqAsNwN76zYrdtx8obu0E4KoUME29B1xj+B3WxgvWkp943vYQ+z8Mv3lw9xHXMHpvSPOBxzAkIa94w==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + + babel-plugin-polyfill-corejs3@0.14.2: + resolution: {integrity: sha512-coWpDLJ410R781Npmn/SIBZEsAetR4xVi0SxLMXPaMO4lSf1MwnkGYMtkFxew0Dn8B3/CpbpYxN0JCgg8mn67g==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + + babel-plugin-polyfill-regenerator@0.6.8: + resolution: {integrity: sha512-M762rNHfSF1EV3SLtnCJXFoQbbIIz0OyRwnCmV0KPC7qosSfCO0QLTSuJX3ayAebubhE6oYBAYPrBA5ljowaZg==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + + balanced-match@1.0.2: + resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} + + balanced-match@4.0.4: + resolution: {integrity: sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==} + engines: {node: 18 || 20 || >=22} + + baseline-browser-mapping@2.10.24: + resolution: {integrity: sha512-I2NkZOOrj2XuguvWCK6OVh9GavsNjZjK908Rq3mIBK25+GD8vPX5w2WdxVqnQ7xx3SrZJiCiZFu+/Oz50oSYSA==} + engines: {node: '>=6.0.0'} + hasBin: true + + better-typescript-lib@2.12.0: + resolution: {integrity: sha512-f7eO5Xs6Cczfx5eDRuDw/JYCrsdiC6gXdleB2KFZ5ZYgU/RRoev9swjt/eD0xo9PRDqNDwyjKx0n27CDHRZwvQ==} + peerDependencies: + typescript: '>=4.5.2' + + binary-searching@2.0.5: + resolution: {integrity: sha512-v4N2l3RxL+m4zDxyxz3Ne2aTmiPn8ZUpKFpdPtO+ItW1NcTCXA7JeHG5GMBSvoKSkQZ9ycS+EouDVxYB9ufKWA==} + + brace-expansion@1.1.14: + resolution: {integrity: sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g==} + + brace-expansion@5.0.5: + resolution: {integrity: sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==} + engines: {node: 18 || 20 || >=22} + + braces@3.0.3: + resolution: {integrity: sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==} + engines: {node: '>=8'} + + browserslist-to-esbuild@2.1.1: + resolution: {integrity: sha512-KN+mty6C3e9AN8Z5dI1xeN15ExcRNeISoC3g7V0Kax/MMF9MSoYA2G7lkTTcVUFntiEjkpI0HNgqJC1NjdyNUw==} + engines: {node: '>=18'} + hasBin: true + peerDependencies: + browserslist: '*' + + browserslist@4.28.2: + resolution: {integrity: sha512-48xSriZYYg+8qXna9kwqjIVzuQxi+KYWp2+5nCYnYKPTr0LvD89Jqk2Or5ogxz0NUMfIjhh2lIUX/LyX9B4oIg==} + engines: {node: ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7} + hasBin: true + + buffer-from@1.1.2: + resolution: {integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==} + + builtin-modules@3.3.0: + resolution: {integrity: sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==} + engines: {node: '>=6'} + + builtin-modules@5.1.0: + resolution: {integrity: sha512-c5JxaDrzwRjq3WyJkI1AGR5xy6Gr6udlt7sQPbl09+3ckB+Zo2qqQ2KhCTBr7Q8dHB43bENGYEk4xddrFH/b7A==} + engines: {node: '>=18.20'} + + bun-types@1.3.13: + resolution: {integrity: sha512-QXKeHLlOLqQX9LgYaHJfzdBaV21T63HhFJnvuRCcjZiaUDpbs5ED1MgxbMra71CsryN/1dAoXuJJJwIv/2drVA==} + + bytes@3.1.2: + resolution: {integrity: sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==} + engines: {node: '>= 0.8'} + + cacheable@2.3.4: + resolution: {integrity: sha512-djgxybDbw9fL/ZWMI3+CE8ZilNxcwFkVtDc1gJ+IlOSSWkSMPQabhV/XCHTQ6pwwN6aivXPZ43omTooZiX06Ew==} + + call-bind-apply-helpers@1.0.2: + resolution: {integrity: sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==} + engines: {node: '>= 0.4'} + + call-bind@1.0.9: + resolution: {integrity: sha512-a/hy+pNsFUTR+Iz8TCJvXudKVLAnz/DyeSUo10I5yvFDQJBFU2s9uqQpoSrJlroHUKoKqzg+epxyP9lqFdzfBQ==} + engines: {node: '>= 0.4'} + + call-bound@1.0.4: + resolution: {integrity: sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==} + engines: {node: '>= 0.4'} + + callsites@3.1.0: + resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==} + engines: {node: '>=6'} + + caniuse-lite@1.0.30001791: + resolution: {integrity: sha512-yk0l/YSrOnFZk3UROpDLQD9+kC1l4meK/wed583AXrzoarMGJcbRi2Q4RaUYbKxYAsZ8sWmaSa/DsLmdBeI1vQ==} + + change-case@5.4.4: + resolution: {integrity: sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==} + + character-entities@2.0.2: + resolution: {integrity: sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==} + + ci-info@4.4.0: + resolution: {integrity: sha512-77PSwercCZU2Fc4sX94eF8k8Pxte6JAwL4/ICZLFjJLqegs7kCuAsqqj/70NQF6TvDpgFjkubQB2FW2ZZddvQg==} + engines: {node: '>=8'} + + clean-regexp@1.0.0: + resolution: {integrity: sha512-GfisEZEJvzKrmGWkvfhgzcz/BllN1USeqD2V6tg14OAOgaCD2Z/PUEuxnAZ/nPvmaHRG7a8y77p1T/IRQ4D1Hw==} + engines: {node: '>=4'} + + color-convert@2.0.1: + resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==} + engines: {node: '>=7.0.0'} + + color-name@1.1.4: + resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==} + + colord@2.9.3: + resolution: {integrity: sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==} + + colorjs.io@0.5.2: + resolution: {integrity: sha512-twmVoizEW7ylZSN32OgKdXRmo1qg+wT5/6C3xu5b9QsWzSFAhHLn2xd8ro0diCsKfCj1RdaTP/nrcW+vAoQPIw==} + + commander@2.20.3: + resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==} + + comment-parser@1.4.6: + resolution: {integrity: sha512-ObxuY6vnbWTN6Od72xfwN9DbzC7Y2vv8u1Soi9ahRKL37gb6y1qk6/dgjs+3JWuXJHWvsg3BXIwzd/rkmAwavg==} + engines: {node: '>= 12.0.0'} + + concat-map@0.0.1: + resolution: {integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==} + + convert-source-map@2.0.0: + resolution: {integrity: sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==} + + core-js-compat@3.49.0: + resolution: {integrity: sha512-VQXt1jr9cBz03b331DFDCCP90b3fanciLkgiOoy8SBHy06gNf+vQ1A3WFLqG7I8TipYIKeYK9wxd0tUrvHcOZA==} + + core-js@3.49.0: + resolution: {integrity: sha512-es1U2+YTtzpwkxVLwAFdSpaIMyQaq0PBgm3YD1W3Qpsn1NAmO3KSgZfu+oGSWVu6NvLHoHCV/aYcsE5wiB7ALg==} + + cosmiconfig@9.0.1: + resolution: {integrity: sha512-hr4ihw+DBqcvrsEDioRO31Z17x71pUYoNe/4h6Z0wB72p7MU7/9gH8Q3s12NFhHPfYBBOV3qyfUxmr/Yn3shnQ==} + engines: {node: '>=14'} + peerDependencies: + typescript: '>=4.9.5' + peerDependenciesMeta: + typescript: + optional: true + + cross-spawn@7.0.6: + resolution: {integrity: sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==} + engines: {node: '>= 8'} + + css-functions-list@3.3.3: + resolution: {integrity: sha512-8HFEBPKhOpJPEPu70wJJetjKta86Gw9+CCyCnB3sui2qQfOvRyqBy4IKLKKAwdMpWb2lHXWk9Wb4Z6AmaUT1Pg==} + engines: {node: '>=12'} + + css-tree@3.2.1: + resolution: {integrity: sha512-X7sjQzceUhu1u7Y/ylrRZFU2FS6LRiFVp6rKLPg23y3x3c3DOKAwuXGDp+PAGjh6CSnCjYeAul8pcT8bAl+lSA==} + engines: {node: ^10 || ^12.20.0 || ^14.13.0 || >=15.0.0} + + cssesc@3.0.0: + resolution: {integrity: sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==} + engines: {node: '>=4'} + hasBin: true + + damerau-levenshtein@1.0.8: + resolution: {integrity: sha512-sdQSFB7+llfUcQHUQO3+B8ERRj0Oa4w9POWMI/puGtuf7gFywGmkaLCElnudfTiKZV+NvHqL0ifzdrI8Ro7ESA==} + + data-view-buffer@1.0.2: + resolution: {integrity: sha512-EmKO5V3OLXh1rtK2wgXRansaK1/mtVdTUEiEI0W8RkvgT05kfxaH29PliLnpLP73yYO6142Q72QNa8Wx/A5CqQ==} + engines: {node: '>= 0.4'} + + data-view-byte-length@1.0.2: + resolution: {integrity: sha512-tuhGbE6CfTM9+5ANGf+oQb72Ky/0+s3xKUpHvShfiz2RxMFgFPjsXuRLBVMtvMs15awe45SRb83D6wH4ew6wlQ==} + engines: {node: '>= 0.4'} + + data-view-byte-offset@1.0.1: + resolution: {integrity: sha512-BS8PfmtDGnrgYdOonGZQdLZslWIeCGFP9tpan0hi1Co2Zr2NKADsvGYA8XxuG/4UWgJ6Cjtv+YJnB6MM69QGlQ==} + engines: {node: '>= 0.4'} + + debug@4.4.3: + resolution: {integrity: sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==} + engines: {node: '>=6.0'} + peerDependenciesMeta: + supports-color: + optional: true + + decode-named-character-reference@1.3.0: + resolution: {integrity: sha512-GtpQYB283KrPp6nRw50q3U9/VfOutZOe103qlN7BPP6Ad27xYnOIWv4lPzo8HCAL+mMZofJ9KEy30fq6MfaK6Q==} + + deep-is@0.1.4: + resolution: {integrity: sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==} + + deepmerge-ts@7.1.5: + resolution: {integrity: sha512-HOJkrhaYsweh+W+e74Yn7YStZOilkoPb6fycpwNLKzSPtruFs48nYis0zy5yJz1+ktUhHxoRDJ27RQAWLIJVJw==} + engines: {node: '>=16.0.0'} + + define-data-property@1.1.4: + resolution: {integrity: sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==} + engines: {node: '>= 0.4'} + + define-properties@1.2.1: + resolution: {integrity: sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==} + engines: {node: '>= 0.4'} + + dequal@2.0.3: + resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} + engines: {node: '>=6'} + + detect-libc@2.1.2: + resolution: {integrity: sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==} + engines: {node: '>=8'} + + devlop@1.1.0: + resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==} + + dunder-proto@1.0.1: + resolution: {integrity: sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==} + engines: {node: '>= 0.4'} + + effect@4.0.0-beta.59: + resolution: {integrity: sha512-xyUDLeHSe8d6lWGOvR6Fgn2HL6gYeTZ/S4Jzk9uc4ZUxMPPsNZlNXrvk0C7/utQFzeX7uAWcVnG2BjbA0SRoAA==} + + electron-to-chromium@1.5.344: + resolution: {integrity: sha512-4MxfbmNDm+KPh066EZy+eUnkcDPcZ35wNmOWzFuh/ijvHsve6kbLTLURy88uCNK5FbpN+yk2nQY6BYh1GEt+wg==} + + emoji-regex@8.0.0: + resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==} + + emoji-regex@9.2.2: + resolution: {integrity: sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==} + + entities@7.0.1: + resolution: {integrity: sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==} + engines: {node: '>=0.12'} + + env-paths@2.2.1: + resolution: {integrity: sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==} + engines: {node: '>=6'} + + error-ex@1.3.4: + resolution: {integrity: sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ==} + + es-abstract@1.24.2: + resolution: {integrity: sha512-2FpH9Q5i2RRwyEP1AylXe6nYLR5OhaJTZwmlcP0dL/+JCbgg7yyEo/sEK6HeGZRf3dFpWwThaRHVApXSkW3xeg==} + engines: {node: '>= 0.4'} + + es-define-property@1.0.1: + resolution: {integrity: sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==} + engines: {node: '>= 0.4'} + + es-errors@1.3.0: + resolution: {integrity: sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==} + engines: {node: '>= 0.4'} + + es-object-atoms@1.1.1: + resolution: {integrity: sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==} + engines: {node: '>= 0.4'} + + es-set-tostringtag@2.1.0: + resolution: {integrity: sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==} + engines: {node: '>= 0.4'} + + es-shim-unscopables@1.1.0: + resolution: {integrity: sha512-d9T8ucsEhh8Bi1woXCf+TIKDIROLG5WCkxg8geBCbvk22kzwC5G2OnXVMO6FUsvQlgUUXQ2itephWDLqDzbeCw==} + engines: {node: '>= 0.4'} + + es-to-primitive@1.3.0: + resolution: {integrity: sha512-w+5mJ3GuFL+NjVtJlvydShqE1eN3h3PbI7/5LAsYJP/2qtuMXjfL2LpHSRqo4b4eSF5K/DH1JXKUAHSB2UW50g==} + engines: {node: '>= 0.4'} + + escalade@3.2.0: + resolution: {integrity: sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==} + engines: {node: '>=6'} + + escape-string-regexp@1.0.5: + resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==} + engines: {node: '>=0.8.0'} + + escape-string-regexp@4.0.0: + resolution: {integrity: sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==} + engines: {node: '>=10'} + + escape-string-regexp@5.0.0: + resolution: {integrity: sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==} + engines: {node: '>=12'} + + eslint-compat-utils@0.6.5: + resolution: {integrity: sha512-vAUHYzue4YAa2hNACjB8HvUQj5yehAZgiClyFVVom9cP8z5NSFq3PwB/TtJslN2zAMgRX6FCFCjYBbQh71g5RQ==} + engines: {node: '>=12'} + peerDependencies: + eslint: '>=6.0.0' + + eslint-plugin-astro@1.7.0: + resolution: {integrity: sha512-89xpAn528UKCdmyysbg0AHHqi6sqcK89wXnJIpu4F0mFBN03zATEBNK7pRtMfl6gwtMOm5ECXs+Wz5qDHhwTFw==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + eslint: '>=8.57.0' + + eslint-plugin-functional@9.0.4: + resolution: {integrity: sha512-zm4qaoqb2r50V4WXxt0Mj92buXGMECYvMxGQ6sSb+XeJ+Eec6zCHuMY2+AWK1mqiApvUz2tCtp1P3zcEPU0huw==} + engines: {node: '>=v18.18.0'} + peerDependencies: + eslint: ^9.0.0 || ^10.0.0 + typescript: '>=4.7.4' + peerDependenciesMeta: + typescript: + optional: true + + eslint-plugin-jsdoc@62.9.0: + resolution: {integrity: sha512-PY7/X4jrVgoIDncUmITlUqK546Ltmx/Pd4Hdsu4CvSjryQZJI2mEV4vrdMufyTetMiZ5taNSqvK//BTgVUlNkA==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + peerDependencies: + eslint: ^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0 + + eslint-plugin-jsx-a11y@6.10.2: + resolution: {integrity: sha512-scB3nz4WmG75pV8+3eRUQOHZlNSUhFNq37xnpgRkCCELU3XMvXAxLk1eqWWyE22Ki4Q01Fnsw9BA3cJHDPgn2Q==} + engines: {node: '>=4.0'} + peerDependencies: + eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9 + + eslint-plugin-oxlint@1.62.0: + resolution: {integrity: sha512-fJ1xrPPw7AwJPH+4rD10qaXbCQfMNa743WnwPwteXLFsUQ0qs9N1Zx8xGJvuWCwvciRJ19dwG+G460fLHrrPdw==} + peerDependencies: + oxlint: ~1.62.0 + + eslint-plugin-perfectionist@5.9.0: + resolution: {integrity: sha512-8TWzg02zmnBdZwCkWLi8jhzqXI+fE7Z/RwV8SL6xD45tJ8Bp3wGuYL2XtQgfe/Wd0eBqOUX+s6ey73IyszvKTA==} + engines: {node: ^20.0.0 || >=22.0.0} + peerDependencies: + eslint: ^8.45.0 || ^9.0.0 || ^10.0.0 + + eslint-plugin-sonarjs@4.0.3: + resolution: {integrity: sha512-5drkJKLC9qQddIiaATV0e8+ygbUc7b0Ti6VB7M2d3jmKNh3X0RaiIJYTs3dr9xnlhlrxo+/s1FoO3Jgv6O/c7g==} + peerDependencies: + eslint: ^8.0.0 || ^9.0.0 || ^10.0.0 + + eslint-plugin-unicorn@64.0.0: + resolution: {integrity: sha512-rNZwalHh8i0UfPlhNwg5BTUO1CMdKNmjqe+TgzOTZnpKoi8VBgsW7u9qCHIdpxEzZ1uwrJrPF0uRb7l//K38gA==} + engines: {node: ^20.10.0 || >=21.0.0} + peerDependencies: + eslint: '>=9.38.0' + + eslint-scope@8.4.0: + resolution: {integrity: sha512-sNXOfKCn74rt8RICKMvJS7XKV/Xk9kA7DyJr8mJik3S7Cwgy3qlkkmyS2uQB3jiJg6VNdZd/pDBJu0nvG2NlTg==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + eslint-scope@9.1.2: + resolution: {integrity: sha512-xS90H51cKw0jltxmvmHy2Iai1LIqrfbw57b79w/J7MfvDfkIkFZ+kj6zC3BjtUwh150HsSSdxXZcsuv72miDFQ==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + eslint-visitor-keys@3.4.3: + resolution: {integrity: sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + + eslint-visitor-keys@4.2.1: + resolution: {integrity: sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + eslint-visitor-keys@5.0.1: + resolution: {integrity: sha512-tD40eHxA35h0PEIZNeIjkHoDR4YjjJp34biM0mDvplBe//mB+IHCqHDGV7pxF+7MklTvighcCPPZC7ynWyjdTA==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + eslint@10.3.0: + resolution: {integrity: sha512-XbEXaRva5cF0ZQB8w6MluHA0kZZfV2DuCMJ3ozyEOHLwDpZX2Lmm/7Pp0xdJmI0GL1W05VH5VwIFHEm1Vcw2gw==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + hasBin: true + peerDependencies: + jiti: '*' + peerDependenciesMeta: + jiti: + optional: true + + espree@10.4.0: + resolution: {integrity: sha512-j6PAQ2uUr79PZhBjP5C5fhl8e39FmRnOjsD5lGnWrFU8i2G776tBK7+nP8KuQUTTyAZUwfQqXAgrVH5MbH9CYQ==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + espree@11.2.0: + resolution: {integrity: sha512-7p3DrVEIopW1B1avAGLuCSh1jubc01H2JHc8B4qqGblmg5gI9yumBgACjWo4JlIc04ufug4xJ3SQI8HkS/Rgzw==} + engines: {node: ^20.19.0 || ^22.13.0 || >=24} + + esquery@1.7.0: + resolution: {integrity: sha512-Ap6G0WQwcU/LHsvLwON1fAQX9Zp0A2Y6Y/cJBl9r/JbW90Zyg4/zbG6zzKa2OTALELarYHmKu0GhpM5EO+7T0g==} + engines: {node: '>=0.10'} + + esrecurse@4.3.0: + resolution: {integrity: sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==} + engines: {node: '>=4.0'} + + estraverse@5.3.0: + resolution: {integrity: sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==} + engines: {node: '>=4.0'} + + esutils@2.0.3: + resolution: {integrity: sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==} + engines: {node: '>=0.10.0'} + + fast-check@4.7.0: + resolution: {integrity: sha512-NsZRtqvSSoCP0HbNjUD+r1JH8zqZalyp6gLY9e7OYs7NK9b6AHOs2baBFeBG7bVNsuoukh89x2Yg3rPsul8ziQ==} + engines: {node: '>=12.17.0'} + + fast-deep-equal@3.1.3: + resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==} + + fast-glob@3.3.3: + resolution: {integrity: sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==} + engines: {node: '>=8.6.0'} + + fast-json-stable-stringify@2.1.0: + resolution: {integrity: sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==} + + fast-levenshtein@2.0.6: + resolution: {integrity: sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==} + + fast-uri@3.1.0: + resolution: {integrity: sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==} + + fastest-levenshtein@1.0.16: + resolution: {integrity: sha512-eRnCtTTtGZFpQCwhJiUOuxPQWRXVKYDn0b2PeHfXL6/Zi53SLAzAHfVhVWK2AryC/WH05kGfxhFIPvTF0SXQzg==} + engines: {node: '>= 4.9.1'} + + fastq@1.20.1: + resolution: {integrity: sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==} + + fd-package-json@2.0.0: + resolution: {integrity: sha512-jKmm9YtsNXN789RS/0mSzOC1NUq9mkVd65vbSSVsKdjGvYXBuE4oWe2QOEoFeRmJg+lPuZxpmrfFclNhoRMneQ==} + + fdir@6.5.0: + resolution: {integrity: sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==} + engines: {node: '>=12.0.0'} + peerDependencies: + picomatch: ^3 || ^4 + peerDependenciesMeta: + picomatch: + optional: true + + file-entry-cache@11.1.2: + resolution: {integrity: sha512-N2WFfK12gmrK1c1GXOqiAJ1tc5YE+R53zvQ+t5P8S5XhnmKYVB5eZEiLNZKDSmoG8wqqbF9EXYBBW/nef19log==} + + file-entry-cache@8.0.0: + resolution: {integrity: sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ==} + engines: {node: '>=16.0.0'} + + fill-range@7.1.1: + resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==} + engines: {node: '>=8'} + + find-my-way-ts@0.1.6: + resolution: {integrity: sha512-a85L9ZoXtNAey3Y6Z+eBWW658kO/MwR7zIafkIUPUMf3isZG0NCs2pjW2wtjxAKuJPxMAsHUIP4ZPGv0o5gyTA==} + + find-up-simple@1.0.1: + resolution: {integrity: sha512-afd4O7zpqHeRyg4PfDQsXmlDe2PfdHtJt6Akt8jOWaApLOZk5JXs6VMR29lz03pRe9mpykrRCYIYxaJYcfpncQ==} + engines: {node: '>=18'} + + find-up@5.0.0: + resolution: {integrity: sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==} + engines: {node: '>=10'} + + flat-cache@4.0.1: + resolution: {integrity: sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw==} + engines: {node: '>=16'} + + flat-cache@6.1.22: + resolution: {integrity: sha512-N2dnzVJIphnNsjHcrxGW7DePckJ6haPrSFqpsBUhHYgwtKGVq4JrBGielEGD2fCVnsGm1zlBVZ8wGhkyuetgug==} + + flatted@3.4.2: + resolution: {integrity: sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA==} + + focusable-selectors@0.8.4: + resolution: {integrity: sha512-0XxbkD0KhOnX10qmnfF9U8DkDD8N/e4M77wMYw2Itoi4vdcoRjSkqXLZFIzkrLIOxzmzCGy88fNG1EbeXMD/zw==} + + for-each@0.3.5: + resolution: {integrity: sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==} + engines: {node: '>= 0.4'} + + formatly@0.3.0: + resolution: {integrity: sha512-9XNj/o4wrRFyhSMJOvsuyMwy8aUfBaZ1VrqHVfohyXf0Sw0e+yfKG+xZaY3arGCOMdwFsqObtzVOc1gU9KiT9w==} + engines: {node: '>=18.3.0'} + hasBin: true + + function-bind@1.1.2: + resolution: {integrity: sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==} + + function.prototype.name@1.1.8: + resolution: {integrity: sha512-e5iwyodOHhbMr/yNrc7fDYG4qlbIvI5gajyzPnb5TCwyhjApznQh1BMFou9b30SevY43gCJKXycoCBjMbsuW0Q==} + engines: {node: '>= 0.4'} + + functional-red-black-tree@1.0.1: + resolution: {integrity: sha512-dsKNQNdj6xA3T+QlADDA7mOSlX0qiMINjn0cgr+eGHGsbSHzTabcIogz2+p/iqP1Xs6EP/sS2SbqH+brGTbq0g==} + + functions-have-names@1.2.3: + resolution: {integrity: sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==} + + generator-function@2.0.1: + resolution: {integrity: sha512-SFdFmIJi+ybC0vjlHN0ZGVGHc3lgE0DxPAT0djjVg+kjOnSqclqmj0KQ7ykTOLP6YxoqOvuAODGdcHJn+43q3g==} + engines: {node: '>= 0.4'} + + gensync@1.0.0-beta.2: + resolution: {integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==} + engines: {node: '>=6.9.0'} + + get-east-asian-width@1.5.0: + resolution: {integrity: sha512-CQ+bEO+Tva/qlmw24dCejulK5pMzVnUOFOijVogd3KQs07HnRIgp8TGipvCCRT06xeYEbpbgwaCxglFyiuIcmA==} + engines: {node: '>=18'} + + get-intrinsic@1.3.1: + resolution: {integrity: sha512-fk1ZVEeOX9hVZ6QzoBNEC55+Ucqg4sTVwrVuigZhuRPESVFpMyXnd3sbXvPOwp7Y9riVyANiqhEuRF0G1aVSeQ==} + engines: {node: '>= 0.4'} + + get-proto@1.0.1: + resolution: {integrity: sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==} + engines: {node: '>= 0.4'} + + get-symbol-description@1.1.0: + resolution: {integrity: sha512-w9UMqWwJxHNOvoNzSJ2oPF5wvYcvP7jUvYzhp67yEhTi17ZDBBC1z9pTdGuzjD+EFIqLSYRweZjqfiPzQ06Ebg==} + engines: {node: '>= 0.4'} + + get-tsconfig@4.14.0: + resolution: {integrity: sha512-yTb+8DXzDREzgvYmh6s9vHsSVCHeC0G3PI5bEXNBHtmshPnO+S5O7qgLEOn0I5QvMy6kpZN8K1NKGyilLb93wA==} + + glob-parent@5.1.2: + resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==} + engines: {node: '>= 6'} + + glob-parent@6.0.2: + resolution: {integrity: sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==} + engines: {node: '>=10.13.0'} + + global-modules@2.0.0: + resolution: {integrity: sha512-NGbfmJBp9x8IxyJSd1P+otYK8vonoJactOogrVfFRIAEY1ukil8RSKDz2Yo7wh1oihl51l/r6W4epkeKJHqL8A==} + engines: {node: '>=6'} + + global-prefix@3.0.0: + resolution: {integrity: sha512-awConJSVCHVGND6x3tmMaKcQvwXLhjdkmomy2W+Goaui8YPgYgXJZewhg3fWC+DlfqqQuWg8AwqjGTD2nAPVWg==} + engines: {node: '>=6'} + + globals@16.5.0: + resolution: {integrity: sha512-c/c15i26VrJ4IRt5Z89DnIzCGDn9EcebibhAOjw5ibqEHsE1wLUgkPn9RDmNcUKyU87GeaL633nyJ+pplFR2ZQ==} + engines: {node: '>=18'} + + globals@17.5.0: + resolution: {integrity: sha512-qoV+HK2yFl/366t2/Cb3+xxPUo5BuMynomoDmiaZBIdbs+0pYbjfZU+twLhGKp4uCZ/+NbtpVepH5bGCxRyy2g==} + engines: {node: '>=18'} + + globals@17.6.0: + resolution: {integrity: sha512-sepffkT8stwnIYbsMBpoCHJuJM5l98FUF2AnE07hfvE0m/qp3R586hw4jF4uadbhvg1ooIdzuu7CsfD2jzCaNA==} + engines: {node: '>=18'} + + globalthis@1.0.4: + resolution: {integrity: sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==} + engines: {node: '>= 0.4'} + + globby@16.2.0: + resolution: {integrity: sha512-QrJia2qDf5BB/V6HYlDTs0I0lBahyjLzpGQg3KT7FnCdTonAyPy2RtY802m2k4ALx6Dp752f82WsOczEVr3l6Q==} + engines: {node: '>=20'} + + globjoin@0.1.4: + resolution: {integrity: sha512-xYfnw62CKG8nLkZBfWbhWwDw02CHty86jfPcc2cr3ZfeuK9ysoVPPEUxf21bAD/rWAgk52SuBrLJlefNy8mvFg==} + + globrex@0.1.2: + resolution: {integrity: sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==} + + gopd@1.2.0: + resolution: {integrity: sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==} + engines: {node: '>= 0.4'} + + has-bigints@1.1.0: + resolution: {integrity: sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==} + engines: {node: '>= 0.4'} + + has-flag@4.0.0: + resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==} + engines: {node: '>=8'} + + has-flag@5.0.1: + resolution: {integrity: sha512-CsNUt5x9LUdx6hnk/E2SZLsDyvfqANZSUq4+D3D8RzDJ2M+HDTIkF60ibS1vHaK55vzgiZw1bEPFG9yH7l33wA==} + engines: {node: '>=12'} + + has-property-descriptors@1.0.2: + resolution: {integrity: sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==} + + has-proto@1.2.0: + resolution: {integrity: sha512-KIL7eQPfHQRC8+XluaIw7BHUwwqL19bQn4hzNgdr+1wXoU0KKj6rufu47lhY7KbJR2C6T6+PfyN0Ea7wkSS+qQ==} + engines: {node: '>= 0.4'} + + has-symbols@1.1.0: + resolution: {integrity: sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==} + engines: {node: '>= 0.4'} + + has-tostringtag@1.0.2: + resolution: {integrity: sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==} + engines: {node: '>= 0.4'} + + hashery@1.5.1: + resolution: {integrity: sha512-iZyKG96/JwPz1N55vj2Ie2vXbhu440zfUfJvSwEqEbeLluk7NnapfGqa7LH0mOsnDxTF85Mx8/dyR6HfqcbmbQ==} + engines: {node: '>=20'} + + hasown@2.0.3: + resolution: {integrity: sha512-ej4AhfhfL2Q2zpMmLo7U1Uv9+PyhIZpgQLGT1F9miIGmiCJIoCgSmczFdrc97mWT4kVY72KA+WnnhJ5pghSvSg==} + engines: {node: '>= 0.4'} + + hookified@1.15.1: + resolution: {integrity: sha512-MvG/clsADq1GPM2KGo2nyfaWVyn9naPiXrqIe4jYjXNZQt238kWyOGrsyc/DmRAQ+Re6yeo6yX/yoNCG5KAEVg==} + + hookified@2.2.0: + resolution: {integrity: sha512-p/LgFzRN5FeoD3DLS6bkUapeye6E4SI6yJs6KetENd18S+FBthqYq2amJUWpt5z0EQwwHemidjY5OqJGEKm5uA==} + + html-element-attributes@3.5.0: + resolution: {integrity: sha512-rU2BFhp0kQla9sqPBI46C+zbP6PFOtD7z6XNAJ6as+cGecCDXLx0W3aIs6XdPLmBBG/Fy1meRi/n65Exofz4Qw==} + + html-entities@2.6.0: + resolution: {integrity: sha512-kig+rMn/QOVRvr7c86gQ8lWXq+Hkv6CbAH1hLu+RG338StTpE8Z0b44SDVaqVu7HGKf27frdmUYEs9hTUX/cLQ==} + + html-es6cape@2.0.2: + resolution: {integrity: sha512-utzhH8rq2VABdW1LsPdv5tmxeMNOtP83If0jKCa79xPBgLWfcMvdf9K+EZoxJ5P7KioCxTs6WBnSDWLQHJ2lWA==} + + html-tags@5.1.0: + resolution: {integrity: sha512-n6l5uca7/y5joxZ3LUePhzmBFUJ+U2YWzhMa8XUTecSeSlQiZdF5XAd/Q3/WUl0VsXgUwWi8I7CNIwdI5WN1SQ==} + engines: {node: '>=20.10'} + + html-template-tag@5.0.0: + resolution: {integrity: sha512-FwF3Fi+v5Dr6ygxqqyJwJWdHteQtDusRXF5ae1syxTKbbVRC8UPtlfIua5KWbgXGneRAc7zNc+Z6x9efFl0W/w==} + + ignore@5.3.2: + resolution: {integrity: sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==} + engines: {node: '>= 4'} + + ignore@7.0.5: + resolution: {integrity: sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==} + engines: {node: '>= 4'} + + immutable@5.1.5: + resolution: {integrity: sha512-t7xcm2siw+hlUM68I+UEOK+z84RzmN59as9DZ7P1l0994DKUWV7UXBMQZVxaoMSRQ+PBZbHCOoBt7a2wxOMt+A==} + + import-fresh@3.3.1: + resolution: {integrity: sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==} + engines: {node: '>=6'} + + import-meta-resolve@4.2.0: + resolution: {integrity: sha512-Iqv2fzaTQN28s/FwZAoFq0ZSs/7hMAHJVX+w8PZl3cY19Pxk6jFFalxQoIfW2826i/fDLXv8IiEZRIT0lDuWcg==} + + imurmurhash@0.1.4: + resolution: {integrity: sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==} + engines: {node: '>=0.8.19'} + + indent-string@5.0.0: + resolution: {integrity: sha512-m6FAo/spmsW2Ab2fU35JTYwtOKa2yAwXSwgjSv1TJzh4Mh7mC3lzAOVLBprb72XsTrgkEIsl7YrFNAiDiRhIGg==} + engines: {node: '>=12'} + + ini@1.3.8: + resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==} + + ini@6.0.0: + resolution: {integrity: sha512-IBTdIkzZNOpqm7q3dRqJvMaldXjDHWkEDfrwGEQTs5eaQMWV+djAhR+wahyNNMAa+qpbDUhBMVt4ZKNwpPm7xQ==} + engines: {node: ^20.17.0 || >=22.9.0} + + internal-slot@1.1.0: + resolution: {integrity: sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==} + engines: {node: '>= 0.4'} + + is-array-buffer@3.0.5: + resolution: {integrity: sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==} + engines: {node: '>= 0.4'} + + is-arrayish@0.2.1: + resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==} + + is-async-function@2.1.1: + resolution: {integrity: sha512-9dgM/cZBnNvjzaMYHVoxxfPj2QXt22Ev7SuuPrs+xav0ukGB0S6d4ydZdEiM48kLx5kDV+QBPrpVnFyefL8kkQ==} + engines: {node: '>= 0.4'} + + is-bigint@1.1.0: + resolution: {integrity: sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==} + engines: {node: '>= 0.4'} + + is-boolean-object@1.2.2: + resolution: {integrity: sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==} + engines: {node: '>= 0.4'} + + is-builtin-module@5.0.0: + resolution: {integrity: sha512-f4RqJKBUe5rQkJ2eJEJBXSticB3hGbN9j0yxxMQFqIW89Jp9WYFtzfTcRlstDKVUTRzSOTLKRfO9vIztenwtxA==} + engines: {node: '>=18.20'} + + is-callable@1.2.7: + resolution: {integrity: sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==} + engines: {node: '>= 0.4'} + + is-core-module@2.16.1: + resolution: {integrity: sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==} + engines: {node: '>= 0.4'} + + is-data-view@1.0.2: + resolution: {integrity: sha512-RKtWF8pGmS87i2D6gqQu/l7EYRlVdfzemCJN/P3UOs//x1QE7mfhvzHIApBTRf7axvT6DMGwSwBXYCT0nfB9xw==} + engines: {node: '>= 0.4'} + + is-date-object@1.1.0: + resolution: {integrity: sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==} + engines: {node: '>= 0.4'} + + is-extglob@2.1.1: + resolution: {integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==} + engines: {node: '>=0.10.0'} + + is-finalizationregistry@1.1.1: + resolution: {integrity: sha512-1pC6N8qWJbWoPtEjgcL2xyhQOP491EQjeUo3qTKcmV8YSDDJrOepfG8pcC7h/QgnQHYSv0mJ3Z/ZWxmatVrysg==} + engines: {node: '>= 0.4'} + + is-fullwidth-code-point@3.0.0: + resolution: {integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==} + engines: {node: '>=8'} + + is-generator-function@1.1.2: + resolution: {integrity: sha512-upqt1SkGkODW9tsGNG5mtXTXtECizwtS2kA161M+gJPc1xdb/Ax629af6YrTwcOeQHbewrPNlE5Dx7kzvXTizA==} + engines: {node: '>= 0.4'} + + is-glob@4.0.3: + resolution: {integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==} + engines: {node: '>=0.10.0'} + + is-immutable-type@5.0.1: + resolution: {integrity: sha512-LkHEOGVZZXxGl8vDs+10k3DvP++SEoYEAJLRk6buTFi6kD7QekThV7xHS0j6gpnUCQ0zpud/gMDGiV4dQneLTg==} + peerDependencies: + eslint: '*' + typescript: '>=4.7.4' + + is-map@2.0.3: + resolution: {integrity: sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==} + engines: {node: '>= 0.4'} + + is-negative-zero@2.0.3: + resolution: {integrity: sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==} + engines: {node: '>= 0.4'} + + is-number-object@1.1.1: + resolution: {integrity: sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==} + engines: {node: '>= 0.4'} + + is-number@7.0.0: + resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==} + engines: {node: '>=0.12.0'} + + is-path-inside@4.0.0: + resolution: {integrity: sha512-lJJV/5dYS+RcL8uQdBDW9c9uWFLLBNRyFhnAKXw5tVqLlKZ4RMGZKv+YQ/IA3OhD+RpbJa1LLFM1FQPGyIXvOA==} + engines: {node: '>=12'} + + is-plain-object@5.0.0: + resolution: {integrity: sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==} + engines: {node: '>=0.10.0'} + + is-regex@1.2.1: + resolution: {integrity: sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==} + engines: {node: '>= 0.4'} + + is-set@2.0.3: + resolution: {integrity: sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==} + engines: {node: '>= 0.4'} + + is-shared-array-buffer@1.0.4: + resolution: {integrity: sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==} + engines: {node: '>= 0.4'} + + is-string@1.1.1: + resolution: {integrity: sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==} + engines: {node: '>= 0.4'} + + is-symbol@1.1.1: + resolution: {integrity: sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==} + engines: {node: '>= 0.4'} + + is-typed-array@1.1.15: + resolution: {integrity: sha512-p3EcsicXjit7SaskXHs1hA91QxgTw46Fv6EFKKGS5DRFLD8yKnohjF3hxoju94b/OcMZoQukzpPpBE9uLVKzgQ==} + engines: {node: '>= 0.4'} + + is-weakmap@2.0.2: + resolution: {integrity: sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==} + engines: {node: '>= 0.4'} + + is-weakref@1.1.1: + resolution: {integrity: sha512-6i9mGWSlqzNMEqpCp93KwRS1uUOodk2OJ6b+sq7ZPDSy2WuI5NFIxp/254TytR8ftefexkWn5xNiHUNpPOfSew==} + engines: {node: '>= 0.4'} + + is-weakset@2.0.4: + resolution: {integrity: sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==} + engines: {node: '>= 0.4'} + + isarray@2.0.5: + resolution: {integrity: sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==} + + isexe@2.0.0: + resolution: {integrity: sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==} + + jiti@2.6.1: + resolution: {integrity: sha512-ekilCSN1jwRvIbgeg/57YFh8qQDNbwDb9xT/qu2DAHbFFZUicIl4ygVaAvzveMhMVr3LnpSKTNnwt8PoOfmKhQ==} + hasBin: true + + js-tokens@4.0.0: + resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} + + js-yaml@4.1.1: + resolution: {integrity: sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==} + hasBin: true + + jsdoc-type-pratt-parser@7.2.0: + resolution: {integrity: sha512-dh140MMgjyg3JhJZY/+iEzW+NO5xR2gpbDFKHqotCmexElVntw7GjWjt511+C/Ef02RU5TKYrJo/Xlzk+OLaTw==} + engines: {node: '>=20.0.0'} + + jsesc@3.1.0: + resolution: {integrity: sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==} + engines: {node: '>=6'} + hasBin: true + + json-buffer@3.0.1: + resolution: {integrity: sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==} + + json-parse-even-better-errors@2.3.1: + resolution: {integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==} + + json-schema-traverse@0.4.1: + resolution: {integrity: sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==} + + json-schema-traverse@1.0.0: + resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==} + + json-stable-stringify-without-jsonify@1.0.1: + resolution: {integrity: sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==} + + json5@2.2.3: + resolution: {integrity: sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==} + engines: {node: '>=6'} + hasBin: true + + jsonc-parser@3.3.1: + resolution: {integrity: sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==} + + jsx-ast-utils-x@0.1.0: + resolution: {integrity: sha512-eQQBjBnsVtGacsG9uJNB8qOr3yA8rga4wAaGG1qRcBzSIvfhERLrWxMAM1hp5fcS6Abo8M4+bUBTekYR0qTPQw==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + + jsx-ast-utils@3.3.5: + resolution: {integrity: sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ==} + engines: {node: '>=4.0'} + + keyv@4.5.4: + resolution: {integrity: sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==} + + keyv@5.6.0: + resolution: {integrity: sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw==} + + kind-of@6.0.3: + resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==} + engines: {node: '>=0.10.0'} + + knip@6.11.0: + resolution: {integrity: sha512-84PTlN8Q5smLpTbzs8smTVh8PMbTDXtw0tFksXq/m6auGFC/KSzJykKFmnYh3As38kiWDkoDBvdTTyKk5M1TAQ==} + engines: {node: ^20.19.0 || >=22.12.0} + hasBin: true + + known-css-properties@0.37.0: + resolution: {integrity: sha512-JCDrsP4Z1Sb9JwG0aJ8Eo2r7k4Ou5MwmThS/6lcIe1ICyb7UBJKGRIUUdqc2ASdE/42lgz6zFUnzAIhtXnBVrQ==} + + kubernetes-types@1.30.0: + resolution: {integrity: sha512-Dew1okvhM/SQcIa2rcgujNndZwU8VnSapDgdxlYoB84ZlpAD43U6KLAFqYo17ykSFGHNPrg0qry0bP+GJd9v7Q==} + + language-subtag-registry@0.3.23: + resolution: {integrity: sha512-0K65Lea881pHotoGEa5gDlMxt3pctLi2RplBb7Ezh4rRdLEOtgi7n4EwK9lamnUCkKBqaeKRVebTq6BAxSkpXQ==} + + language-tags@1.0.9: + resolution: {integrity: sha512-MbjN408fEndfiQXbFQ1vnd+1NoLDsnQW41410oQBXiyXDMYH5z505juWa4KUE1LqxRC7DgOgZDbKLxHIwm27hA==} + engines: {node: '>=0.10'} + + levn@0.4.1: + resolution: {integrity: sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==} + engines: {node: '>= 0.8.0'} + + lightningcss-cli-linux-x64-gnu@1.32.0: + resolution: {integrity: sha512-QMQllbHYkbkQ4N+v8OGExQlGHBc3YZIcKlVkYucQQj66thkFQsRjmv8p5q3iCB0inNsCoSZ8lBspugkU1iPlPg==} + engines: {node: '>= 12.0.0'} + os: + - linux + cpu: + - x64 + + lightningcss-cli-linux-x64-musl@1.32.0: + resolution: {integrity: sha512-dMSWdk4kMAi5f+J1xetxRCDQOvPix2whT0UdjuwP8r/5Xcdl2SQU/c80MQzu1S82kVDEANs1vHVEHp/+26LUnA==} + engines: {node: '>= 12.0.0'} + os: + - linux + cpu: + - x64 + + lightningcss-cli@1.32.0: + resolution: {integrity: sha512-IFb/ChmSEbeWU3xeRybR6WFlJXCvfDS84//PUzLrRACgvoWrwRJBmcPS9azSo7LMh5QqEuyKanPBByhKM5z01Q==} + engines: {node: '>= 12.0.0'} + hasBin: true + + lightningcss-linux-x64-gnu@1.32.0: + resolution: {integrity: sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==} + engines: {node: '>= 12.0.0'} + os: + - linux + cpu: + - x64 + + lightningcss-linux-x64-musl@1.32.0: + resolution: {integrity: sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==} + engines: {node: '>= 12.0.0'} + os: + - linux + cpu: + - x64 + + lightningcss@1.32.0: + resolution: {integrity: sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ==} + engines: {node: '>= 12.0.0'} + + lines-and-columns@1.2.4: + resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} + + lit-html@3.3.2: + resolution: {integrity: sha512-Qy9hU88zcmaxBXcc10ZpdK7cOLXvXpRoBxERdtqV9QOrfpMZZ6pSYP91LhpPtap3sFMUiL7Tw2RImbe0Al2/kw==} + + locate-path@6.0.0: + resolution: {integrity: sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==} + engines: {node: '>=10'} + + lodash.debounce@4.0.8: + resolution: {integrity: sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==} + + lodash.merge@4.6.2: + resolution: {integrity: sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==} + + lodash.truncate@4.4.2: + resolution: {integrity: sha512-jttmRe7bRse52OsWIMDLaXxWqRAmtIUccAQ3garviCqJjafXOfNMO0yMfNpdD6zbGaTU0P5Nz7e7gAT6cKmJRw==} + + lru-cache@5.1.1: + resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==} + + magic-string@0.30.21: + resolution: {integrity: sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==} + + math-intrinsics@1.1.0: + resolution: {integrity: sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==} + engines: {node: '>= 0.4'} + + mathml-tag-names@4.0.0: + resolution: {integrity: sha512-aa6AU2Pcx0VP/XWnh8IGL0SYSgQHDT6Ucror2j2mXeFAlN3ahaNs8EZtG1YiticMkSLj3Gt6VPFfZogt7G5iFQ==} + + mdast-util-from-markdown@2.0.3: + resolution: {integrity: sha512-W4mAWTvSlKvf8L6J+VN9yLSqQ9AOAAvHuoDAmPkz4dHf553m5gVj2ejadHJhoJmcmxEnOv6Pa8XJhpxE93kb8Q==} + + mdast-util-to-string@4.0.0: + resolution: {integrity: sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==} + + mdn-data@2.27.1: + resolution: {integrity: sha512-9Yubnt3e8A0OKwxYSXyhLymGW4sCufcLG6VdiDdUGVkPhpqLxlvP5vl1983gQjJl3tqbrM731mjaZaP68AgosQ==} + + meow@13.2.0: + resolution: {integrity: sha512-pxQJQzB6djGPXh08dacEloMFopsOqGVRKFPYvPOt9XDZ1HasbgDZA74CJGreSU4G3Ak7EFJGoiH2auq+yXISgA==} + engines: {node: '>=18'} + + meow@14.1.0: + resolution: {integrity: sha512-EDYo6VlmtnumlcBCbh1gLJ//9jvM/ndXHfVXIFrZVr6fGcwTUyCTFNTLCKuY3ffbK8L/+3Mzqnd58RojiZqHVw==} + engines: {node: '>=20'} + + merge2@1.4.1: + resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} + engines: {node: '>= 8'} + + micromark-core-commonmark@2.0.3: + resolution: {integrity: sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==} + + micromark-factory-destination@2.0.1: + resolution: {integrity: sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==} + + micromark-factory-label@2.0.1: + resolution: {integrity: sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==} + + micromark-factory-space@2.0.1: + resolution: {integrity: sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==} + + micromark-factory-title@2.0.1: + resolution: {integrity: sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==} + + micromark-factory-whitespace@2.0.1: + resolution: {integrity: sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==} + + micromark-util-character@2.1.1: + resolution: {integrity: sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==} + + micromark-util-chunked@2.0.1: + resolution: {integrity: sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==} + + micromark-util-classify-character@2.0.1: + resolution: {integrity: sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==} + + micromark-util-combine-extensions@2.0.1: + resolution: {integrity: sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==} + + micromark-util-decode-numeric-character-reference@2.0.2: + resolution: {integrity: sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==} + + micromark-util-decode-string@2.0.1: + resolution: {integrity: sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==} + + micromark-util-encode@2.0.1: + resolution: {integrity: sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==} + + micromark-util-html-tag-name@2.0.1: + resolution: {integrity: sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==} + + micromark-util-normalize-identifier@2.0.1: + resolution: {integrity: sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==} + + micromark-util-resolve-all@2.0.1: + resolution: {integrity: sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==} + + micromark-util-sanitize-uri@2.0.1: + resolution: {integrity: sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==} + + micromark-util-subtokenize@2.1.0: + resolution: {integrity: sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==} + + micromark-util-symbol@2.0.1: + resolution: {integrity: sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==} + + micromark-util-types@2.0.2: + resolution: {integrity: sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==} + + micromark@4.0.2: + resolution: {integrity: sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==} + + micromatch@4.0.8: + resolution: {integrity: sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==} + engines: {node: '>=8.6'} + + minimatch@10.2.5: + resolution: {integrity: sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg==} + engines: {node: 18 || 20 || >=22} + + minimatch@3.1.5: + resolution: {integrity: sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==} + engines: {node: '*'} + + minimist@1.2.8: + resolution: {integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==} + + ms@2.1.3: + resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} + + msgpackr-extract@3.0.3: + resolution: {integrity: sha512-P0efT1C9jIdVRefqjzOQ9Xml57zpOXnIuS+csaB4MdZbTdmGDLo8XhzBG1N7aO11gKDDkJvBLULeFTo46wwreA==} + hasBin: true + + msgpackr@1.11.10: + resolution: {integrity: sha512-iCZNq+HszvF+fC3anCm4nBmWEnbeIAfpDs6IStAEKhQ2YSgkjzVG2FF9XJqwwQh5bH3N9OUTUt4QwVN6MLMLtA==} + + multipasta@0.2.7: + resolution: {integrity: sha512-KPA58d68KgGil15oDqXjkUBEBYc00XvbPj5/X+dyzeo/lWm9Nc25pQRlf1D+gv4OpK7NM0J1odrbu9JNNGvynA==} + + nanoid@3.3.11: + resolution: {integrity: sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==} + engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} + hasBin: true + + natural-compare@1.4.0: + resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==} + + natural-orderby@5.0.0: + resolution: {integrity: sha512-kKHJhxwpR/Okycz4HhQKKlhWe4ASEfPgkSWNmKFHd7+ezuQlxkA5cM3+XkBPvm1gmHen3w53qsYAv+8GwRrBlg==} + engines: {node: '>=18'} + + node-gyp-build-optional-packages@5.2.2: + resolution: {integrity: sha512-s+w+rBWnpTMwSFbaE0UXsRlg7hU4FjekKU4eyAih5T8nJuNZT1nNsskXpxmeqSK9UzkBl6UgRlnKc8hz8IEqOw==} + hasBin: true + + node-releases@2.0.38: + resolution: {integrity: sha512-3qT/88Y3FbH/Kx4szpQQ4HzUbVrHPKTLVpVocKiLfoYvw9XSGOX2FmD2d6DrXbVYyAQTF2HeF6My8jmzx7/CRw==} + + normalize-path@3.0.0: + resolution: {integrity: sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==} + engines: {node: '>=0.10.0'} + + object-deep-merge@2.0.0: + resolution: {integrity: sha512-3DC3UMpeffLTHiuXSy/UG4NOIYTLlY9u3V82+djSCLYClWobZiS4ivYzpIUWrRY/nfsJ8cWsKyG3QfyLePmhvg==} + + object-inspect@1.13.4: + resolution: {integrity: sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==} + engines: {node: '>= 0.4'} + + object-keys@1.1.1: + resolution: {integrity: sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==} + engines: {node: '>= 0.4'} + + object.assign@4.1.7: + resolution: {integrity: sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==} + engines: {node: '>= 0.4'} + + object.fromentries@2.0.8: + resolution: {integrity: sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==} + engines: {node: '>= 0.4'} + + object.values@1.2.1: + resolution: {integrity: sha512-gXah6aZrcUxjWg2zR2MwouP2eHlCBzdV4pygudehaKXSGW4v2AsRQUK+lwwXhii6KFZcunEnmSUoYp5CXibxtA==} + engines: {node: '>= 0.4'} + + optionator@0.9.4: + resolution: {integrity: sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==} + engines: {node: '>= 0.8.0'} + + own-keys@1.0.1: + resolution: {integrity: sha512-qFOyK5PjiWZd+QQIh+1jhdb9LpxTF0qs7Pm8o5QHYZ0M3vKqSqzsZaEB6oWlxZ+q2sJBMI/Ktgd2N5ZwQoRHfg==} + engines: {node: '>= 0.4'} + + oxc-parser@0.128.0: + resolution: {integrity: sha512-XkOw3eiIxAgQ19WRew/Bq9wc5Ga/guaWIzDBzq80z1PyuDNGvWBpPby9k6YGwV8A8uMw+Nlq3xqlzuDYmUFYUw==} + engines: {node: ^20.19.0 || >=22.12.0} + + oxc-resolver@11.19.1: + resolution: {integrity: sha512-qE/CIg/spwrTBFt5aKmwe3ifeDdLfA2NESN30E42X/lII5ClF8V7Wt6WIJhcGZjp0/Q+nQ+9vgxGk//xZNX2hg==} + + oxlint-tsgolint@0.22.1: + resolution: {integrity: sha512-YUSGSLUnoolsu8gxISEDio3q1rtsCozwfOzASUn3DT2mR2EeQ93uEEnen7s+6LpF+lyTQFln1pQfqwBh/fsVEg==} + hasBin: true + + oxlint@1.62.0: + resolution: {integrity: sha512-1uFkg6HakjsGIpW9wNdeW4/2LOHW9MEkoWjZUTUfQtIHyLIZPYt00w3Sg+H3lH+206FgBPHBbW5dVE5l2ExECQ==} + engines: {node: ^20.19.0 || >=22.12.0} + hasBin: true + peerDependencies: + oxlint-tsgolint: '>=0.18.0' + peerDependenciesMeta: + oxlint-tsgolint: + optional: true + + p-limit@3.1.0: + resolution: {integrity: sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==} + engines: {node: '>=10'} + + p-locate@5.0.0: + resolution: {integrity: sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==} + engines: {node: '>=10'} + + parent-module@1.0.1: + resolution: {integrity: sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==} + engines: {node: '>=6'} + + parse-imports-exports@0.2.4: + resolution: {integrity: sha512-4s6vd6dx1AotCx/RCI2m7t7GCh5bDRUtGNvRfHSP2wbBQdMi67pPe7mtzmgwcaQ8VKK/6IB7Glfyu3qdZJPybQ==} + + parse-json@5.2.0: + resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==} + engines: {node: '>=8'} + + parse-statements@1.0.11: + resolution: {integrity: sha512-HlsyYdMBnbPQ9Jr/VgJ1YF4scnldvJpJxCVx6KgqPL4dxppsWrJHCIIxQXMJrqGnsRkNPATbeMJ8Yxu7JMsYcA==} + + path-exists@4.0.0: + resolution: {integrity: sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==} + engines: {node: '>=8'} + + path-key@3.1.1: + resolution: {integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==} + engines: {node: '>=8'} + + path-parse@1.0.7: + resolution: {integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==} + + picocolors@1.1.1: + resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==} + + picomatch@2.3.2: + resolution: {integrity: sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==} + engines: {node: '>=8.6'} + + picomatch@4.0.4: + resolution: {integrity: sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==} + engines: {node: '>=12'} + + playwright-core@1.59.1: + resolution: {integrity: sha512-HBV/RJg81z5BiiZ9yPzIiClYV/QMsDCKUyogwH9p3MCP6IYjUFu/MActgYAvK0oWyV9NlwM3GLBjADyWgydVyg==} + engines: {node: '>=18'} + hasBin: true + + playwright@1.59.1: + resolution: {integrity: sha512-C8oWjPR3F81yljW9o5OxcWzfh6avkVwDD2VYdwIGqTkl+OGFISgypqzfu7dOe4QNLL2aqcWBmI3PMtLIK233lw==} + engines: {node: '>=18'} + hasBin: true + + pluralize@8.0.0: + resolution: {integrity: sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==} + engines: {node: '>=4'} + + possible-typed-array-names@1.1.0: + resolution: {integrity: sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==} + engines: {node: '>= 0.4'} + + postcss-media-query-parser@0.2.3: + resolution: {integrity: sha512-3sOlxmbKcSHMjlUXQZKQ06jOswE7oVkXPxmZdoB1r5l0q6gTFTQSHxNxOrCccElbW7dxNytifNEo8qidX2Vsig==} + + postcss-resolve-nested-selector@0.1.6: + resolution: {integrity: sha512-0sglIs9Wmkzbr8lQwEyIzlDOOC9bGmfVKcJTaxv3vMmd3uo4o4DerC3En0bnmgceeql9BfC8hRkp7cg0fjdVqw==} + + postcss-safe-parser@7.0.1: + resolution: {integrity: sha512-0AioNCJZ2DPYz5ABT6bddIqlhgwhpHZ/l65YAYo0BCIn0xiDpsnTHz0gnoTGk0OXZW0JRs+cDwL8u/teRdz+8A==} + engines: {node: '>=18.0'} + peerDependencies: + postcss: ^8.4.31 + + postcss-scss@4.0.9: + resolution: {integrity: sha512-AjKOeiwAitL/MXxQW2DliT28EKukvvbEWx3LBmJIRN8KfBGZbRTxNYW0kSqi1COiTZ57nZ9NW06S6ux//N1c9A==} + engines: {node: '>=12.0'} + peerDependencies: + postcss: ^8.4.29 + + postcss-selector-parser@7.1.1: + resolution: {integrity: sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg==} + engines: {node: '>=4'} + + postcss-sorting@10.0.0: + resolution: {integrity: sha512-TXbU+h6vVRW+86c/+ewhWq9k7pr7ijASTnepVhCQiC87zAOTkvB1v2dHyWP+ggstSTX/PNvjzS+IOqzejndz9w==} + peerDependencies: + postcss: ^8.4.20 + + postcss-value-parser@4.2.0: + resolution: {integrity: sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==} + + postcss@8.5.12: + resolution: {integrity: sha512-W62t/Se6rA0Az3DfCL0AqJwXuKwBeYg6nOaIgzP+xZ7N5BFCI7DYi1qs6ygUYT6rvfi6t9k65UMLJC+PHZpDAA==} + engines: {node: ^10 || ^12 || >=14} + + prelude-ls@1.2.1: + resolution: {integrity: sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==} + engines: {node: '>= 0.8.0'} + + prettier-plugin-curly@0.4.1: + resolution: {integrity: sha512-Xc7zatoD0/08zYFv+hwnlqT5ekM81DCbBr73CWAsr1Fmx7qLQT/M0wfPx6w/+zfnmXH009xYvjzLUPcwzq7Fbw==} + engines: {node: '>=18'} + peerDependencies: + prettier: ^3 + + prettier-plugin-ini@1.3.0: + resolution: {integrity: sha512-kX1KnPwITCTtYV0MTBZQKuFLxcNcbHOS9r7Ta1jHLLvRvZRTzHHqX0MEZMrCkedjLuxpQSgzr4aC5IRd+R3FPw==} + + prettier-plugin-jsdoc@1.8.0: + resolution: {integrity: sha512-byW8EBZ1DSA3CPdDGBXfcdqqhh2eq0+HlIOPTGZ6rf9O2p/AwBmtS0e49ot5ZeOdcszj81FyzbyHr/VS0eYpCg==} + engines: {node: '>=14.13.1 || >=16.0.0'} + peerDependencies: + prettier: ^3.0.0 + + prettier-plugin-pkg@0.22.1: + resolution: {integrity: sha512-l9qnxic48hgTXsvXi9yWWWzovpqkEYo/Ljf8Af7zSkDTNVmLwscXW63IEVMJXH94DyloO8YkogeLheJUzJh/ZQ==} + engines: {node: ^14.18.0 || >=16.0.0} + peerDependencies: + prettier: ^3.0.3 + + prettier-plugin-sh@0.18.1: + resolution: {integrity: sha512-uZmU22wBMevjh3rmCatNQqiEer2+5KLa0xYCBX6zQQUQkcNzVL+s6FbPKK6ZSUNUbQk6jMAcQHrYPvuL2W6ihQ==} + engines: {node: '>=16.0.0'} + peerDependencies: + prettier: ^3.6.0 + + prettier-plugin-sort-json@4.2.0: + resolution: {integrity: sha512-jK1w3/7otTvHtv1eoLji2U9mEoOGeyl7QQQ/afLnjht1YtRLSUUk8o0rIIC/HUVXhoGPCFe4SVZbRGYjjUVgvA==} + engines: {node: '>=18.0.0'} + peerDependencies: + prettier: ^3.0.0 + + prettier@3.8.3: + resolution: {integrity: sha512-7igPTM53cGHMW8xWuVTydi2KO233VFiTNyF5hLJqpilHfmn8C8gPf+PS7dUT64YcXFbiMGZxS9pCSxL/Dxm/Jw==} + engines: {node: '>=14'} + hasBin: true + + punycode@2.3.1: + resolution: {integrity: sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==} + engines: {node: '>=6'} + + pure-rand@8.4.0: + resolution: {integrity: sha512-IoM8YF/jY0hiugFo/wOWqfmarlE6J0wc6fDK1PhftMk7MGhVZl88sZimmqBBFomLOCSmcCCpsfj7wXASCpvK9A==} + + purify-ts@2.1.2: + resolution: {integrity: sha512-v9RnHfoxZJZt5PeZork6zErRwYnGKxUiO7wk+NqPnJcG7AKjt97ut41WbGRMSUuMBexrXZsVNePSMcO9qPHODQ==} + + qified@0.9.1: + resolution: {integrity: sha512-n7mar4T0xQ+39dE2vGTAlbxUEpndwPANH0kDef1/MYsB8Bba9wshkybIRx74qgcvKQPEWErf9AqAdYjhzY2Ilg==} + engines: {node: '>=20'} + + queue-microtask@1.2.3: + resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==} + + refa@0.12.1: + resolution: {integrity: sha512-J8rn6v4DBb2nnFqkqwy6/NnTYMcgLA+sLr0iIO41qpv0n+ngb7ksag2tMRl0inb1bbO/esUwzW1vbJi7K0sI0g==} + engines: {node: ^12.0.0 || ^14.0.0 || >=16.0.0} + + reflect.getprototypeof@1.0.10: + resolution: {integrity: sha512-00o4I+DVrefhv+nX0ulyi3biSHCPDe+yLv5o/p6d/UVlirijB8E16FtfwSAi4g3tcqrQ4lRAqQSoFEZJehYEcw==} + engines: {node: '>= 0.4'} + + regenerate-unicode-properties@10.2.2: + resolution: {integrity: sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==} + engines: {node: '>=4'} + + regenerate@1.4.2: + resolution: {integrity: sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==} + + regenerator-runtime@0.14.1: + resolution: {integrity: sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==} + + regexp-ast-analysis@0.7.1: + resolution: {integrity: sha512-sZuz1dYW/ZsfG17WSAG7eS85r5a0dDsvg+7BiiYR5o6lKCAtUrEwdmRmaGF6rwVj3LcmAeYkOWKEPlbPzN3Y3A==} + engines: {node: ^12.0.0 || ^14.0.0 || >=16.0.0} + + regexp-tree@0.1.27: + resolution: {integrity: sha512-iETxpjK6YoRWJG5o6hXLwvjYAoW+FEZn9os0PD/b6AP6xQwsa/Y7lCVgIixBbUPMfhu+i2LtdeAqVTgGlQarfA==} + hasBin: true + + regexp.prototype.flags@1.5.4: + resolution: {integrity: sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==} + engines: {node: '>= 0.4'} + + regexpu-core@6.4.0: + resolution: {integrity: sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==} + engines: {node: '>=4'} + + regjsgen@0.8.0: + resolution: {integrity: sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==} + + regjsparser@0.13.1: + resolution: {integrity: sha512-dLsljMd9sqwRkby8zhO1gSg3PnJIBFid8f4CQj/sXx+7cKx+E7u0PKhZ+U4wmhx7EfmtvnA318oVaIkAB1lRJw==} + hasBin: true + + require-from-string@2.0.2: + resolution: {integrity: sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==} + engines: {node: '>=0.10.0'} + + reserved-identifiers@1.2.0: + resolution: {integrity: sha512-yE7KUfFvaBFzGPs5H3Ops1RevfUEsDc5Iz65rOwWg4lE8HJSYtle77uul3+573457oHvBKuHYDl/xqUkKpEEdw==} + engines: {node: '>=18'} + + resolve-from@4.0.0: + resolution: {integrity: sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==} + engines: {node: '>=4'} + + resolve-pkg-maps@1.0.0: + resolution: {integrity: sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==} + + resolve@1.22.12: + resolution: {integrity: sha512-TyeJ1zif53BPfHootBGwPRYT1RUt6oGWsaQr8UyZW/eAm9bKoijtvruSDEmZHm92CwS9nj7/fWttqPCgzep8CA==} + engines: {node: '>= 0.4'} + hasBin: true + + reusify@1.1.0: + resolution: {integrity: sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==} + engines: {iojs: '>=1.0.0', node: '>=0.10.0'} + + rolldown@1.0.0-rc.17: + resolution: {integrity: sha512-ZrT53oAKrtA4+YtBWPQbtPOxIbVDbxT0orcYERKd63VJTF13zPcgXTvD4843L8pcsI7M6MErt8QtON6lrB9tyA==} + engines: {node: ^20.19.0 || >=22.12.0} + hasBin: true + + run-parallel@1.2.0: + resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} + + rxjs@7.8.2: + resolution: {integrity: sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA==} + + safe-array-concat@1.1.4: + resolution: {integrity: sha512-wtZlHyOje6OZTGqAoaDKxFkgRtkF9CnHAVnCHKfuj200wAgL+bSJhdsCD2l0Qx/2ekEXjPWcyKkfGb5CPboslg==} + engines: {node: '>=0.4'} + + safe-push-apply@1.0.0: + resolution: {integrity: sha512-iKE9w/Z7xCzUMIZqdBsp6pEQvwuEebH4vdpjcDWnyzaI6yl6O9FHvVpmGelvEHNsoY6wGblkxR6Zty/h00WiSA==} + engines: {node: '>= 0.4'} + + safe-regex-test@1.1.0: + resolution: {integrity: sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==} + engines: {node: '>= 0.4'} + + sass-embedded-linux-musl-x64@1.99.0: + resolution: {integrity: sha512-huhgOMmOc30r7CH7qbRbT9LerSEGSnWuS4CYNOskr9BvNeQp4dIneFufNRGZ7hkOAxUM8DglxIZJN/cyAT95Ew==} + engines: {node: '>=14.0.0'} + os: + - linux + cpu: + - x64 + + sass-embedded-linux-x64@1.99.0: + resolution: {integrity: sha512-9k7IkULqIZdCIVt4Mboryt6vN8Mjmm3EhI1P3mClU5y5i3wLK5ExC3cbVWk047KsID/fvB1RLslqghXJx5BoxA==} + engines: {node: '>=14.0.0'} + os: + - linux + cpu: + - x64 + + sass-embedded@1.99.0: + resolution: {integrity: sha512-gF/juR1aX02lZHkvwxdF80SapkQeg2fetoDF6gIQkNbSw5YEUFspMkyGTjPjgZSgIHuZpy+Wz4PlebKnLXMjdg==} + engines: {node: '>=16.0.0'} + hasBin: true + + scslre@0.3.0: + resolution: {integrity: sha512-3A6sD0WYP7+QrjbfNA2FN3FsOaGGFoekCVgTyypy53gPxhbkCIjtO6YWgdrfM+n/8sI8JeXZOIxsHjMTNxQ4nQ==} + engines: {node: ^14.0.0 || >=16.0.0} + + semver@6.3.1: + resolution: {integrity: sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==} + hasBin: true + + semver@7.7.4: + resolution: {integrity: sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==} + engines: {node: '>=10'} + hasBin: true + + set-function-length@1.2.2: + resolution: {integrity: sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==} + engines: {node: '>= 0.4'} + + set-function-name@2.0.2: + resolution: {integrity: sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==} + engines: {node: '>= 0.4'} + + set-proto@1.0.0: + resolution: {integrity: sha512-RJRdvCo6IAnPdsvP/7m6bsQqNnn1FCBX5ZNtFL98MmFF/4xAIJTIg1YbHW5DC2W5SKZanrC6i4HsJqlajw/dZw==} + engines: {node: '>= 0.4'} + + sh-syntax@0.5.8: + resolution: {integrity: sha512-JfVoxf4FxQI5qpsPbkHhZo+n6N9YMJobyl4oGEUBb/31oQYlgTjkXQD8PBiafS2UbWoxrTO0Z5PJUBXEPAG1Zw==} + engines: {node: '>=16.0.0'} + + shebang-command@2.0.0: + resolution: {integrity: sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==} + engines: {node: '>=8'} + + shebang-regex@3.0.0: + resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} + engines: {node: '>=8'} + + side-channel-list@1.0.1: + resolution: {integrity: sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w==} + engines: {node: '>= 0.4'} + + side-channel-map@1.0.1: + resolution: {integrity: sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==} + engines: {node: '>= 0.4'} + + side-channel-weakmap@1.0.2: + resolution: {integrity: sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==} + engines: {node: '>= 0.4'} + + side-channel@1.1.0: + resolution: {integrity: sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==} + engines: {node: '>= 0.4'} + + signal-exit@4.1.0: + resolution: {integrity: sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==} + engines: {node: '>=14'} + + slash@5.1.0: + resolution: {integrity: sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==} + engines: {node: '>=14.16'} + + slice-ansi@4.0.0: + resolution: {integrity: sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==} + engines: {node: '>=10'} + + smol-toml@1.6.1: + resolution: {integrity: sha512-dWUG8F5sIIARXih1DTaQAX4SsiTXhInKf1buxdY9DIg4ZYPZK5nGM1VRIYmEbDbsHt7USo99xSLFu5Q1IqTmsg==} + engines: {node: '>= 18'} + + source-map-js@1.2.1: + resolution: {integrity: sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==} + engines: {node: '>=0.10.0'} + + source-map-support@0.5.21: + resolution: {integrity: sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==} + + source-map@0.6.1: + resolution: {integrity: sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==} + engines: {node: '>=0.10.0'} + + spdx-exceptions@2.5.0: + resolution: {integrity: sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==} + + spdx-expression-parse@4.0.0: + resolution: {integrity: sha512-Clya5JIij/7C6bRR22+tnGXbc4VKlibKSVj2iHvVeX5iMW7s1SIQlqu699JkODJJIhh/pUu8L0/VLh8xflD+LQ==} + + spdx-license-ids@3.0.23: + resolution: {integrity: sha512-CWLcCCH7VLu13TgOH+r8p1O/Znwhqv/dbb6lqWy67G+pT1kHmeD/+V36AVb/vq8QMIQwVShJ6Ssl5FPh0fuSdw==} + + stop-iteration-iterator@1.1.0: + resolution: {integrity: sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==} + engines: {node: '>= 0.4'} + + string-width@4.2.3: + resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==} + engines: {node: '>=8'} + + string-width@8.2.1: + resolution: {integrity: sha512-IIaP0g3iy9Cyy18w3M9YcaDudujEAVHKt3a3QJg1+sr/oX96TbaGUubG0hJyCjCBThFH+tFpcIyoUHUn1ogaLA==} + engines: {node: '>=20'} + + string.prototype.includes@2.0.1: + resolution: {integrity: sha512-o7+c9bW6zpAdJHTtujeePODAhkuicdAryFsfVKwA+wGw89wJ4GTY484WTucM9hLtDEOpOvI+aHnzqnC5lHp4Rg==} + engines: {node: '>= 0.4'} + + string.prototype.trim@1.2.10: + resolution: {integrity: sha512-Rs66F0P/1kedk5lyYyH9uBzuiI/kNRmwJAR9quK6VOtIpZ2G+hMZd+HQbbv25MgCA6gEffoMZYxlTod4WcdrKA==} + engines: {node: '>= 0.4'} + + string.prototype.trimend@1.0.9: + resolution: {integrity: sha512-G7Ok5C6E/j4SGfyLCloXTrngQIQU3PWtXGst3yM7Bea9FRURf1S42ZHlZZtsNque2FN2PoUhfZXYLNWwEr4dLQ==} + engines: {node: '>= 0.4'} + + string.prototype.trimstart@1.0.8: + resolution: {integrity: sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==} + engines: {node: '>= 0.4'} + + strip-ansi@6.0.1: + resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} + engines: {node: '>=8'} + + strip-ansi@7.2.0: + resolution: {integrity: sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==} + engines: {node: '>=12'} + + strip-indent@4.1.1: + resolution: {integrity: sha512-SlyRoSkdh1dYP0PzclLE7r0M9sgbFKKMFXpFRUMNuKhQSbC6VQIGzq3E0qsfvGJaUFJPGv6Ws1NZ/haTAjfbMA==} + engines: {node: '>=12'} + + strip-json-comments@5.0.3: + resolution: {integrity: sha512-1tB5mhVo7U+ETBKNf92xT4hrQa3pm0MZ0PQvuDnWgAAGHDsfp4lPSpiS6psrSiet87wyGPh9ft6wmhOMQ0hDiw==} + engines: {node: '>=14.16'} + + style-search@0.1.0: + resolution: {integrity: sha512-Dj1Okke1C3uKKwQcetra4jSuk0DqbzbYtXipzFlFMZtowbF1x7BKJwB9AayVMyFARvU8EDrZdcax4At/452cAg==} + + stylelint-config-clean-order@8.0.1: + resolution: {integrity: sha512-zKjp7BiINXRZOG9m0fE/6UKoM6clPekL+LoAiHMCiQU2hgirKL5G0mKc5Z0ygIhQXfb1+DTRDM0mu6Ecdv4q8g==} + peerDependencies: + stylelint: '>=16' + stylelint-order: '>=6' + + stylelint-config-recommended-scss@17.0.1: + resolution: {integrity: sha512-x5DVehzJudcwF0od3sGpgkln2PLLranFE7twwbp7dqDINCyZvwzFkMc6TLhNOvazRiVBJYATQLouJY0xPGB8WA==} + engines: {node: '>=20'} + peerDependencies: + postcss: ^8.3.3 + stylelint: ^17.0.0 + peerDependenciesMeta: + postcss: + optional: true + + stylelint-config-recommended@18.0.0: + resolution: {integrity: sha512-mxgT2XY6YZ3HWWe3Di8umG6aBmWmHTblTgu/f10rqFXnyWxjKWwNdjSWkgkwCtxIKnqjSJzvFmPT5yabVIRxZg==} + engines: {node: '>=20.19.0'} + peerDependencies: + stylelint: ^17.0.0 + + stylelint-config-sass-guidelines@13.0.0: + resolution: {integrity: sha512-YJT0X8h0OqyEo7ys3EycV5CGWt2rrkEYE8sHSN6sFnrxbXvHiy4KJFHDOWfyb3eWR6wtYpM+yIyvR2Plc8+pCg==} + engines: {node: '>=20.19.0'} + peerDependencies: + postcss: ^8.4.21 + stylelint: ^17.1.0 + + stylelint-config-standard-scss@17.0.0: + resolution: {integrity: sha512-uLJS6xgOCBw5EMsDW7Ukji8l28qRoMnkRch15s0qwZpskXvWt9oPzMmcYM307m9GN4MxuWLsQh4I6hU9yI53cQ==} + engines: {node: '>=20'} + peerDependencies: + postcss: ^8.3.3 + stylelint: ^17.0.0 + peerDependenciesMeta: + postcss: + optional: true + + stylelint-config-standard@40.0.0: + resolution: {integrity: sha512-EznGJxOUhtWck2r6dJpbgAdPATIzvpLdK9+i5qPd4Lx70es66TkBPljSg4wN3Qnc6c4h2n+WbUrUynQ3fanjHw==} + engines: {node: '>=20.19.0'} + peerDependencies: + stylelint: ^17.0.0 + + stylelint-declaration-block-no-ignored-properties@3.0.0: + resolution: {integrity: sha512-3ml4NgSW6nkHQrk+/ounU7Qljfb7e7FayHzU7Mry6rF9X28RXyPLD2bNn4QVOO7t98d5EGCCVkNbHCZSx+bNUQ==} + engines: {node: '>=20.19.0'} + peerDependencies: + stylelint: ^17.0.0 + + stylelint-order@8.1.1: + resolution: {integrity: sha512-LqsEB6VggJuu5v10RtkrQsBObcdwBE7GuAOlwfc/LR3VL/w8UqKX2BOLIjhyGt0Gne/njo7gRNGiJAKhfmPMNw==} + engines: {node: '>=20.19.0'} + peerDependencies: + stylelint: ^16.18.0 || ^17.0.0 + + stylelint-plugin-logical-css@2.1.0: + resolution: {integrity: sha512-625OT+p5y2kkGBaRV7uTYscuH0m1UueMXh0WcidrXgwF2DOnKov+un9tvuyNG+SUC07W0ibcn+fZvQs/keskww==} + peerDependencies: + stylelint: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 + + stylelint-scss@7.0.0: + resolution: {integrity: sha512-H88kCC+6Vtzj76NsC8rv6x/LW8slBzIbyeSjsKVlS+4qaEJoDrcJR4L+8JdrR2ORdTscrBzYWiiT2jq6leYR1Q==} + engines: {node: '>=20.19.0'} + peerDependencies: + stylelint: ^16.8.2 || ^17.0.0 + + stylelint@17.9.1: + resolution: {integrity: sha512-THTmnAPJTrg/JhkTWZlSyrO+HUYMx6ELthIHeMyD2WOKqXIJUFQv2Yxn91bvUrZdbBJaW2dUuQdPST2wcQ6C3g==} + engines: {node: '>=20.19.0'} + hasBin: true + + supports-color@10.2.2: + resolution: {integrity: sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g==} + engines: {node: '>=18'} + + supports-color@8.1.1: + resolution: {integrity: sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==} + engines: {node: '>=10'} + + supports-hyperlinks@4.4.0: + resolution: {integrity: sha512-UKbpT93hN5Nr9go5UY7bopIB9YQlMz9nm/ct4IXt/irb5YRkn9WaqrOBJGZ5Pwvsd5FQzSVeYlGdXoCAPQZrPg==} + engines: {node: '>=20'} + + supports-preserve-symlinks-flag@1.0.0: + resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} + engines: {node: '>= 0.4'} + + svg-tags@1.0.0: + resolution: {integrity: sha512-ovssysQTa+luh7A5Weu3Rta6FJlFBBbInjOh722LIt6klpU2/HtdUbszju/G4devcvk8PGt7FCLv5wftu3THUA==} + + sync-child-process@1.0.2: + resolution: {integrity: sha512-8lD+t2KrrScJ/7KXCSyfhT3/hRq78rC0wBFqNJXv3mZyn6hW2ypM05JmlSvtqRbeq6jqA94oHbxAr2vYsJ8vDA==} + engines: {node: '>=16.0.0'} + + sync-message-port@1.2.0: + resolution: {integrity: sha512-gAQ9qrUN/UCypHtGFbbe7Rc/f9bzO88IwrG8TDo/aMKAApKyD6E3W4Cm0EfhfBb6Z6SKt59tTCTfD+n1xmAvMg==} + engines: {node: '>=16.0.0'} + + synckit@0.11.12: + resolution: {integrity: sha512-Bh7QjT8/SuKUIfObSXNHNSK6WHo6J1tHCqJsuaFDP7gP0fkzSfTxI8y85JrppZ0h8l0maIgc2tfuZQ6/t3GtnQ==} + engines: {node: ^14.18.0 || >=16.0.0} + + systemjs@6.15.1: + resolution: {integrity: sha512-Nk8c4lXvMB98MtbmjX7JwJRgJOL8fluecYCfCeYBznwmpOs8Bf15hLM6z4z71EDAhQVrQrI+wt1aLWSXZq+hXA==} + + table@6.9.0: + resolution: {integrity: sha512-9kY+CygyYM6j02t5YFHbNz2FN5QmYGv9zAjVp4lCDjlCw7amdckXlEt/bjMhUIfj4ThGRE4gCUH5+yGnNuPo5A==} + engines: {node: '>=10.0.0'} + + terser@5.46.2: + resolution: {integrity: sha512-uxfo9fPcSgLDYob/w1FuL0c99MWiJDnv+5qXSQc5+Ki5NjVNsYi66INnMFBjf6uFz6OnX12piJQPF4IpjJTNTw==} + engines: {node: '>=10'} + hasBin: true + + tinyglobby@0.2.16: + resolution: {integrity: sha512-pn99VhoACYR8nFHhxqix+uvsbXineAasWm5ojXoN8xEwK5Kd3/TrhNn1wByuD52UxWRLy8pu+kRMniEi6Eq9Zg==} + engines: {node: '>=12.0.0'} + + to-regex-range@5.0.1: + resolution: {integrity: sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==} + engines: {node: '>=8.0'} + + to-valid-identifier@1.0.0: + resolution: {integrity: sha512-41wJyvKep3yT2tyPqX/4blcfybknGB4D+oETKLs7Q76UiPqRpUJK3hr1nxelyYO0PHKVzJwlu0aCeEAsGI6rpw==} + engines: {node: '>=20'} + + toml@4.1.1: + resolution: {integrity: sha512-EBJnVBr3dTXdA89WVFoAIPUqkBjxPMwRqsfuo1r240tKFHXv3zgca4+NJib/h6TyvGF7vOawz0jGuryJCdNHrw==} + engines: {node: '>=20'} + + ts-api-utils@2.5.0: + resolution: {integrity: sha512-OJ/ibxhPlqrMM0UiNHJ/0CKQkoKF243/AEmplt3qpRgkW8VG7IfOS41h7V8TjITqdByHzrjcS/2si+y4lIh8NA==} + engines: {node: '>=18.12'} + peerDependencies: + typescript: '>=4.8.4' + + ts-declaration-location@1.0.7: + resolution: {integrity: sha512-EDyGAwH1gO0Ausm9gV6T2nUvBgXT5kGoCMJPllOaooZ+4VvJiKBdZE7wK18N1deEowhcUptS+5GXZK8U/fvpwA==} + peerDependencies: + typescript: '>=4.0.0' + + ts-pattern@5.9.0: + resolution: {integrity: sha512-6s5V71mX8qBUmlgbrfL33xDUwO0fq48rxAu2LBE11WBeGdpCPOsXksQbZJHvHwhrd3QjUusd3mAOM5Gg0mFBLg==} + + tsconfck@3.1.6: + resolution: {integrity: sha512-ks6Vjr/jEw0P1gmOVwutM3B7fWxoWBL2KRDb1JfqGVawBmO5UsvmWOQFGHBPl5yxYz4eERr19E6L7NMv+Fej4w==} + engines: {node: ^18 || >=20} + hasBin: true + peerDependencies: + typescript: ^5.0.0 + peerDependenciesMeta: + typescript: + optional: true + + tslib@2.8.1: + resolution: {integrity: sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==} + + type-check@0.4.0: + resolution: {integrity: sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==} + engines: {node: '>= 0.8.0'} + + typed-array-buffer@1.0.3: + resolution: {integrity: sha512-nAYYwfY3qnzX30IkA6AQZjVbtK6duGontcQm1WSG1MD94YLqK0515GNApXkoxKOWMusVssAHWLh9SeaoefYFGw==} + engines: {node: '>= 0.4'} + + typed-array-byte-length@1.0.3: + resolution: {integrity: sha512-BaXgOuIxz8n8pIq3e7Atg/7s+DpiYrxn4vdot3w9KbnBhcRQq6o3xemQdIfynqSeXeDrF32x+WvfzmOjPiY9lg==} + engines: {node: '>= 0.4'} + + typed-array-byte-offset@1.0.4: + resolution: {integrity: sha512-bTlAFB/FBYMcuX81gbL4OcpH5PmlFHqlCCpAl8AlEzMz5k53oNDvN8p1PNOWLEmI2x4orp3raOFB51tv9X+MFQ==} + engines: {node: '>= 0.4'} + + typed-array-length@1.0.7: + resolution: {integrity: sha512-3KS2b+kL7fsuk/eJZ7EQdnEmQoaho/r6KUef7hxvltNA5DR8NAUM+8wJMbJyZ4G9/7i3v5zPBIMN5aybAh2/Jg==} + engines: {node: '>= 0.4'} + + typescript-eslint@8.59.1: + resolution: {integrity: sha512-xqDcFVBmlrltH64lklOVp1wYxgJr6LVdg3NamBgH2OOQDLFdTKfIZXF5PfghrnXQKXZGTQs8tr1vL7fJvq8CTQ==} + engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} + peerDependencies: + eslint: ^8.57.0 || ^9.0.0 || ^10.0.0 + typescript: '>=4.8.4 <6.1.0' + + typescript@6.0.3: + resolution: {integrity: sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw==} + engines: {node: '>=14.17'} + hasBin: true + + unbash@3.0.0: + resolution: {integrity: sha512-FeFPZ/WFT0mbRCuydiZzpPFlrYN8ZUpphQKoq4EeElVIYjYyGzPMxQR/simUwCOJIyVhpFk4RbtyO7RuMpMnHA==} + engines: {node: '>=14'} + + unbox-primitive@1.1.0: + resolution: {integrity: sha512-nWJ91DjeOkej/TA8pXQ3myruKpKEYgqvpw9lz4OPHj/NWFNluYrjbz9j01CJ8yKQd2g4jFoOkINCTW2I5LEEyw==} + engines: {node: '>= 0.4'} + + undici-types@7.19.2: + resolution: {integrity: sha512-qYVnV5OEm2AW8cJMCpdV20CDyaN3g0AjDlOGf1OW4iaDEx8MwdtChUp4zu4H0VP3nDRF/8RKWH+IPp9uW0YGZg==} + + unicode-canonical-property-names-ecmascript@2.0.1: + resolution: {integrity: sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg==} + engines: {node: '>=4'} + + unicode-match-property-ecmascript@2.0.0: + resolution: {integrity: sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==} + engines: {node: '>=4'} + + unicode-match-property-value-ecmascript@2.2.1: + resolution: {integrity: sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg==} + engines: {node: '>=4'} + + unicode-property-aliases-ecmascript@2.2.0: + resolution: {integrity: sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ==} + engines: {node: '>=4'} + + unicorn-magic@0.4.0: + resolution: {integrity: sha512-wH590V9VNgYH9g3lH9wWjTrUoKsjLF6sGLjhR4sH1LWpLmCOH0Zf7PukhDA8BiS7KHe4oPNkcTHqYkj7SOGUOw==} + engines: {node: '>=20'} + + unist-util-stringify-position@4.0.0: + resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==} + + update-browserslist-db@1.2.3: + resolution: {integrity: sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==} + hasBin: true + peerDependencies: + browserslist: '>= 4.21.0' + + uri-js@4.4.1: + resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==} + + util-deprecate@1.0.2: + resolution: {integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==} + + uuid@13.0.0: + resolution: {integrity: sha512-XQegIaBTVUjSHliKqcnFqYypAd4S+WCYt5NIeRs6w/UAry7z8Y9j5ZwRRL4kzq9U3sD6v+85er9FvkEaBpji2w==} + hasBin: true + + valibot@1.1.0: + resolution: {integrity: sha512-Nk8lX30Qhu+9txPYTwM0cFlWLdPFsFr6LblzqIySfbZph9+BFsAHsNvHOymEviUepeIW6KFHzpX8TKhbptBXXw==} + peerDependencies: + typescript: '>=5' + peerDependenciesMeta: + typescript: + optional: true + + varint@6.0.0: + resolution: {integrity: sha512-cXEIW6cfr15lFv563k4GuVuW/fiwjknytD37jIOLSdSWuOI6WnO/oKwmP2FQTU2l01LP8/M5TSAJpzUaGe3uWg==} + + vite-tsconfig-paths@6.1.1: + resolution: {integrity: sha512-2cihq7zliibCCZ8P9cKJrQBkfgdvcFkOOc3Y02o3GWUDLgqjWsZudaoiuOwO/gzTzy17cS5F7ZPo4bsnS4DGkg==} + peerDependencies: + vite: '*' + + vite@8.0.10: + resolution: {integrity: sha512-rZuUu9j6J5uotLDs+cAA4O5H4K1SfPliUlQwqa6YEwSrWDZzP4rhm00oJR5snMewjxF5V/K3D4kctsUTsIU9Mw==} + engines: {node: ^20.19.0 || >=22.12.0} + hasBin: true + 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 + peerDependenciesMeta: + '@types/node': + optional: true + '@vitejs/devtools': + optional: true + esbuild: + optional: true + jiti: + optional: true + less: + optional: true + sass: + optional: true + sass-embedded: + optional: true + stylus: + optional: true + sugarss: + optional: true + terser: + optional: true + tsx: + optional: true + yaml: + optional: true + + walk-up-path@4.0.0: + resolution: {integrity: sha512-3hu+tD8YzSLGuFYtPRb48vdhKMi0KQV5sn+uWr8+7dMEq/2G/dtLrdDinkLjqq5TIbIBjYJ4Ax/n3YiaW7QM8A==} + engines: {node: 20 || >=22} + + which-boxed-primitive@1.1.1: + resolution: {integrity: sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==} + engines: {node: '>= 0.4'} + + which-builtin-type@1.2.1: + resolution: {integrity: sha512-6iBczoX+kDQ7a3+YJBnh3T+KZRxM/iYNPXicqk66/Qfm1b93iu+yOImkg0zHbj5LNOcNv1TEADiZ0xa34B4q6Q==} + engines: {node: '>= 0.4'} + + which-collection@1.0.2: + resolution: {integrity: sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==} + engines: {node: '>= 0.4'} + + which-typed-array@1.1.20: + resolution: {integrity: sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==} + engines: {node: '>= 0.4'} + + which@1.3.1: + resolution: {integrity: sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==} + hasBin: true + + which@2.0.2: + resolution: {integrity: sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==} + engines: {node: '>= 8'} + hasBin: true + + word-wrap@1.2.5: + resolution: {integrity: sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==} + engines: {node: '>=0.10.0'} + + write-file-atomic@7.0.1: + resolution: {integrity: sha512-OTIk8iR8/aCRWBqvxrzxR0hgxWpnYBblY1S5hDWBQfk/VFmJwzmJgQFN3WsoUKHISv2eAwe+PpbUzyL1CKTLXg==} + engines: {node: ^20.17.0 || >=22.9.0} + + yallist@3.1.1: + resolution: {integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==} + + yaml@2.8.3: + resolution: {integrity: sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==} + engines: {node: '>= 14.6'} + hasBin: true + + yocto-queue@0.1.0: + resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} + engines: {node: '>=10'} + + zod@4.3.6: + resolution: {integrity: sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg==} + +snapshots: + + '@astrojs/compiler@3.0.1': {} + + '@babel/code-frame@7.29.0': + dependencies: + '@babel/helper-validator-identifier': 7.28.5 + js-tokens: 4.0.0 + picocolors: 1.1.1 + + '@babel/compat-data@7.29.0': {} + + '@babel/core@7.29.0': + dependencies: + '@babel/code-frame': 7.29.0 + '@babel/generator': 7.29.1 + '@babel/helper-compilation-targets': 7.28.6 + '@babel/helper-module-transforms': 7.28.6(@babel/core@7.29.0) + '@babel/helpers': 7.29.2 + '@babel/parser': 7.29.2 + '@babel/template': 7.28.6 + '@babel/traverse': 7.29.0 + '@babel/types': 7.29.0 + '@jridgewell/remapping': 2.3.5 + convert-source-map: 2.0.0 + debug: 4.4.3 + gensync: 1.0.0-beta.2 + json5: 2.2.3 + semver: 6.3.1 + + '@babel/generator@7.29.1': + dependencies: + '@babel/parser': 7.29.2 + '@babel/types': 7.29.0 + '@jridgewell/gen-mapping': 0.3.13 + '@jridgewell/trace-mapping': 0.3.31 + jsesc: 3.1.0 + + '@babel/helper-annotate-as-pure@7.27.3': + dependencies: + '@babel/types': 7.29.0 + + '@babel/helper-compilation-targets@7.28.6': + dependencies: + '@babel/compat-data': 7.29.0 + '@babel/helper-validator-option': 7.27.1 + browserslist: 4.28.2 + lru-cache: 5.1.1 + semver: 6.3.1 + + '@babel/helper-create-class-features-plugin@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-annotate-as-pure': 7.27.3 + '@babel/helper-member-expression-to-functions': 7.28.5 + '@babel/helper-optimise-call-expression': 7.27.1 + '@babel/helper-replace-supers': 7.28.6(@babel/core@7.29.0) + '@babel/helper-skip-transparent-expression-wrappers': 7.27.1 + '@babel/traverse': 7.29.0 + semver: 6.3.1 + + '@babel/helper-create-regexp-features-plugin@7.28.5(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-annotate-as-pure': 7.27.3 + regexpu-core: 6.4.0 + semver: 6.3.1 + + '@babel/helper-define-polyfill-provider@0.6.8(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-compilation-targets': 7.28.6 + '@babel/helper-plugin-utils': 7.28.6 + debug: 4.4.3 + lodash.debounce: 4.0.8 + resolve: 1.22.12 + + '@babel/helper-globals@7.28.0': {} + + '@babel/helper-member-expression-to-functions@7.28.5': + dependencies: + '@babel/traverse': 7.29.0 + '@babel/types': 7.29.0 + + '@babel/helper-module-imports@7.28.6': + dependencies: + '@babel/traverse': 7.29.0 + '@babel/types': 7.29.0 + + '@babel/helper-module-transforms@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-module-imports': 7.28.6 + '@babel/helper-validator-identifier': 7.28.5 + '@babel/traverse': 7.29.0 + + '@babel/helper-optimise-call-expression@7.27.1': + dependencies: + '@babel/types': 7.29.0 + + '@babel/helper-plugin-utils@7.28.6': {} + + '@babel/helper-remap-async-to-generator@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-annotate-as-pure': 7.27.3 + '@babel/helper-wrap-function': 7.28.6 + '@babel/traverse': 7.29.0 + + '@babel/helper-replace-supers@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-member-expression-to-functions': 7.28.5 + '@babel/helper-optimise-call-expression': 7.27.1 + '@babel/traverse': 7.29.0 + + '@babel/helper-skip-transparent-expression-wrappers@7.27.1': + dependencies: + '@babel/traverse': 7.29.0 + '@babel/types': 7.29.0 + + '@babel/helper-string-parser@7.27.1': {} + + '@babel/helper-validator-identifier@7.28.5': {} + + '@babel/helper-validator-option@7.27.1': {} + + '@babel/helper-wrap-function@7.28.6': + dependencies: + '@babel/template': 7.28.6 + '@babel/traverse': 7.29.0 + '@babel/types': 7.29.0 + + '@babel/helpers@7.29.2': + dependencies: + '@babel/template': 7.28.6 + '@babel/types': 7.29.0 + + '@babel/parser@7.29.2': + dependencies: + '@babel/types': 7.29.0 + + '@babel/plugin-bugfix-firefox-class-in-computed-class-key@7.28.5(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/traverse': 7.29.0 + + '@babel/plugin-bugfix-safari-class-field-initializer-scope@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-skip-transparent-expression-wrappers': 7.27.1 + '@babel/plugin-transform-optional-chaining': 7.28.6(@babel/core@7.29.0) + + '@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/traverse': 7.29.0 + + '@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + + '@babel/plugin-syntax-import-assertions@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-syntax-import-attributes@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-syntax-unicode-sets-regex@7.18.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-arrow-functions@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-async-generator-functions@7.29.0(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-remap-async-to-generator': 7.27.1(@babel/core@7.29.0) + '@babel/traverse': 7.29.0 + + '@babel/plugin-transform-async-to-generator@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-module-imports': 7.28.6 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-remap-async-to-generator': 7.27.1(@babel/core@7.29.0) + + '@babel/plugin-transform-block-scoped-functions@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-block-scoping@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-class-properties@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-class-features-plugin': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-class-static-block@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-class-features-plugin': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-classes@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-annotate-as-pure': 7.27.3 + '@babel/helper-compilation-targets': 7.28.6 + '@babel/helper-globals': 7.28.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-replace-supers': 7.28.6(@babel/core@7.29.0) + '@babel/traverse': 7.29.0 + + '@babel/plugin-transform-computed-properties@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/template': 7.28.6 + + '@babel/plugin-transform-destructuring@7.28.5(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/traverse': 7.29.0 + + '@babel/plugin-transform-dotall-regex@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-duplicate-keys@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-duplicate-named-capturing-groups-regex@7.29.0(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-dynamic-import@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-explicit-resource-management@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/plugin-transform-destructuring': 7.28.5(@babel/core@7.29.0) + + '@babel/plugin-transform-exponentiation-operator@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-export-namespace-from@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-for-of@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-skip-transparent-expression-wrappers': 7.27.1 + + '@babel/plugin-transform-function-name@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-compilation-targets': 7.28.6 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/traverse': 7.29.0 + + '@babel/plugin-transform-json-strings@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-literals@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-logical-assignment-operators@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-member-expression-literals@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-modules-amd@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-module-transforms': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-modules-commonjs@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-module-transforms': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-modules-systemjs@7.29.0(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-module-transforms': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-validator-identifier': 7.28.5 + '@babel/traverse': 7.29.0 + + '@babel/plugin-transform-modules-umd@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-module-transforms': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-named-capturing-groups-regex@7.29.0(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-new-target@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-nullish-coalescing-operator@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-numeric-separator@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-object-rest-spread@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-compilation-targets': 7.28.6 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/plugin-transform-destructuring': 7.28.5(@babel/core@7.29.0) + '@babel/plugin-transform-parameters': 7.27.7(@babel/core@7.29.0) + '@babel/traverse': 7.29.0 + + '@babel/plugin-transform-object-super@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-replace-supers': 7.28.6(@babel/core@7.29.0) + + '@babel/plugin-transform-optional-catch-binding@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-optional-chaining@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-skip-transparent-expression-wrappers': 7.27.1 + + '@babel/plugin-transform-parameters@7.27.7(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-private-methods@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-class-features-plugin': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-private-property-in-object@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-annotate-as-pure': 7.27.3 + '@babel/helper-create-class-features-plugin': 7.28.6(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-property-literals@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-regenerator@7.29.0(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-regexp-modifiers@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-reserved-words@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-shorthand-properties@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-spread@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-skip-transparent-expression-wrappers': 7.27.1 + + '@babel/plugin-transform-sticky-regex@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-template-literals@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-typeof-symbol@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-unicode-escapes@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-unicode-property-regex@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-unicode-regex@7.27.1(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/plugin-transform-unicode-sets-regex@7.28.6(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-create-regexp-features-plugin': 7.28.5(@babel/core@7.29.0) + '@babel/helper-plugin-utils': 7.28.6 + + '@babel/preset-env@7.29.2(@babel/core@7.29.0)': + dependencies: + '@babel/compat-data': 7.29.0 + '@babel/core': 7.29.0 + '@babel/helper-compilation-targets': 7.28.6 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/helper-validator-option': 7.27.1 + '@babel/plugin-bugfix-firefox-class-in-computed-class-key': 7.28.5(@babel/core@7.29.0) + '@babel/plugin-bugfix-safari-class-field-initializer-scope': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-proposal-private-property-in-object': 7.21.0-placeholder-for-preset-env.2(@babel/core@7.29.0) + '@babel/plugin-syntax-import-assertions': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-syntax-import-attributes': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-syntax-unicode-sets-regex': 7.18.6(@babel/core@7.29.0) + '@babel/plugin-transform-arrow-functions': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-async-generator-functions': 7.29.0(@babel/core@7.29.0) + '@babel/plugin-transform-async-to-generator': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-block-scoped-functions': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-block-scoping': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-class-properties': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-class-static-block': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-classes': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-computed-properties': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-destructuring': 7.28.5(@babel/core@7.29.0) + '@babel/plugin-transform-dotall-regex': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-duplicate-keys': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-duplicate-named-capturing-groups-regex': 7.29.0(@babel/core@7.29.0) + '@babel/plugin-transform-dynamic-import': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-explicit-resource-management': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-exponentiation-operator': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-export-namespace-from': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-for-of': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-function-name': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-json-strings': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-literals': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-logical-assignment-operators': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-member-expression-literals': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-modules-amd': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-modules-commonjs': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-modules-systemjs': 7.29.0(@babel/core@7.29.0) + '@babel/plugin-transform-modules-umd': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-named-capturing-groups-regex': 7.29.0(@babel/core@7.29.0) + '@babel/plugin-transform-new-target': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-nullish-coalescing-operator': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-numeric-separator': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-object-rest-spread': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-object-super': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-optional-catch-binding': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-optional-chaining': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-parameters': 7.27.7(@babel/core@7.29.0) + '@babel/plugin-transform-private-methods': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-private-property-in-object': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-property-literals': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-regenerator': 7.29.0(@babel/core@7.29.0) + '@babel/plugin-transform-regexp-modifiers': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-reserved-words': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-shorthand-properties': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-spread': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-sticky-regex': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-template-literals': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-typeof-symbol': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-unicode-escapes': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-unicode-property-regex': 7.28.6(@babel/core@7.29.0) + '@babel/plugin-transform-unicode-regex': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-unicode-sets-regex': 7.28.6(@babel/core@7.29.0) + '@babel/preset-modules': 0.1.6-no-external-plugins(@babel/core@7.29.0) + babel-plugin-polyfill-corejs2: 0.4.17(@babel/core@7.29.0) + babel-plugin-polyfill-corejs3: 0.14.2(@babel/core@7.29.0) + babel-plugin-polyfill-regenerator: 0.6.8(@babel/core@7.29.0) + core-js-compat: 3.49.0 + semver: 6.3.1 + + '@babel/preset-modules@0.1.6-no-external-plugins(@babel/core@7.29.0)': + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-plugin-utils': 7.28.6 + '@babel/types': 7.29.0 + esutils: 2.0.3 + + '@babel/template@7.28.6': + dependencies: + '@babel/code-frame': 7.29.0 + '@babel/parser': 7.29.2 + '@babel/types': 7.29.0 + + '@babel/traverse@7.29.0': + dependencies: + '@babel/code-frame': 7.29.0 + '@babel/generator': 7.29.1 + '@babel/helper-globals': 7.28.0 + '@babel/parser': 7.29.2 + '@babel/template': 7.28.6 + '@babel/types': 7.29.0 + debug: 4.4.3 + + '@babel/types@7.29.0': + dependencies: + '@babel/helper-string-parser': 7.27.1 + '@babel/helper-validator-identifier': 7.28.5 + + '@bufbuild/protobuf@2.12.0': {} + + '@cacheable/memory@2.0.8': + dependencies: + '@cacheable/utils': 2.4.1 + '@keyv/bigmap': 1.3.1(keyv@5.6.0) + hookified: 1.15.1 + keyv: 5.6.0 + + '@cacheable/utils@2.4.1': + dependencies: + hashery: 1.5.1 + keyv: 5.6.0 + + '@csstools/css-calc@3.2.0(@csstools/css-parser-algorithms@4.0.0(@csstools/css-tokenizer@4.0.0))(@csstools/css-tokenizer@4.0.0)': + dependencies: + '@csstools/css-parser-algorithms': 4.0.0(@csstools/css-tokenizer@4.0.0) + '@csstools/css-tokenizer': 4.0.0 + + '@csstools/css-parser-algorithms@4.0.0(@csstools/css-tokenizer@4.0.0)': + dependencies: + '@csstools/css-tokenizer': 4.0.0 + + '@csstools/css-syntax-patches-for-csstree@1.1.3(css-tree@3.2.1)': + dependencies: + css-tree: 3.2.1 + + '@csstools/css-tokenizer@4.0.0': {} + ? '@csstools/media-query-list-parser@5.0.0(@csstools/css-parser-algorithms@4.0.0(@csstools/css-tokenizer@4.0.0))(@csstools/css-tokenizer@4.0.0)' + + : dependencies: + '@csstools/css-parser-algorithms': 4.0.0(@csstools/css-tokenizer@4.0.0) + '@csstools/css-tokenizer': 4.0.0 + + '@csstools/selector-resolve-nested@4.0.0(postcss-selector-parser@7.1.1)': + dependencies: + postcss-selector-parser: 7.1.1 + + '@csstools/selector-specificity@6.0.0(postcss-selector-parser@7.1.1)': + dependencies: + postcss-selector-parser: 7.1.1 + + '@effect/language-service@0.85.1': {} + + '@effect/tsgo-linux-x64@0.5.2': {} + + '@effect/tsgo@0.5.2': + optionalDependencies: + '@effect/tsgo-linux-x64': 0.5.2 + + '@es-joy/jsdoccomment@0.86.0': + dependencies: + '@types/estree': 1.0.8 + '@typescript-eslint/types': 8.59.1 + comment-parser: 1.4.6 + esquery: 1.7.0 + jsdoc-type-pratt-parser: 7.2.0 + + '@es-joy/resolve.exports@1.2.0': {} + + '@eslint-community/eslint-utils@4.9.1(eslint@10.3.0(jiti@2.6.1))': + dependencies: + eslint: 10.3.0(jiti@2.6.1) + eslint-visitor-keys: 3.4.3 + + '@eslint-community/regexpp@4.12.2': {} + + '@eslint/config-array@0.23.5': + dependencies: + '@eslint/object-schema': 3.0.5 + debug: 4.4.3 + minimatch: 10.2.5 + + '@eslint/config-helpers@0.5.5': + dependencies: + '@eslint/core': 1.2.1 + + '@eslint/core@1.2.1': + dependencies: + '@types/json-schema': 7.0.15 + + '@eslint/js@10.0.1(eslint@10.3.0(jiti@2.6.1))': + dependencies: + eslint: 10.3.0(jiti@2.6.1) + + '@eslint/object-schema@3.0.5': {} + + '@eslint/plugin-kit@0.7.1': + dependencies: + '@eslint/core': 1.2.1 + levn: 0.4.1 + + '@gcch/configuration-eslint@https://git.gcch.fr/gcch/configuration-eslint#888eb4aa54e5bfd6251566d7469ee99204c19f45': + dependencies: + '@eslint/js': 10.0.1(eslint@10.3.0(jiti@2.6.1)) + astro-eslint-parser: 1.4.0 + eslint: 10.3.0(jiti@2.6.1) + eslint-plugin-functional: 9.0.4(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + eslint-plugin-jsdoc: 62.9.0(eslint@10.3.0(jiti@2.6.1)) + eslint-plugin-perfectionist: 5.9.0(eslint@10.3.0(jiti@2.6.1)) + eslint-plugin-sonarjs: 4.0.3(eslint@10.3.0(jiti@2.6.1)) + eslint-plugin-unicorn: 64.0.0(eslint@10.3.0(jiti@2.6.1)) + globals: 17.6.0 + typescript-eslint: 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + + '@gcch/configuration-oxlint@https://git.gcch.fr/gcch/configuration-oxlint#83547fc1ebfd6cb402e3c7f074b3e267632ebf4a': + dependencies: + eslint-plugin-astro: 1.7.0(eslint@10.3.0(jiti@2.6.1)) + eslint-plugin-functional: 9.0.4(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + eslint-plugin-jsx-a11y: 6.10.2(eslint@10.3.0(jiti@2.6.1)) + eslint-plugin-perfectionist: 5.9.0(eslint@10.3.0(jiti@2.6.1)) + globals: 17.6.0 + oxlint: 1.62.0(oxlint-tsgolint@0.22.1) + oxlint-tsgolint: 0.22.1 + + '@gcch/configuration-prettier@https://git.gcch.fr/gcch/configuration-prettier#d267d6dc5ee8f14378180d71f651009bf7aa3acc': + dependencies: + prettier: 3.8.3 + prettier-plugin-curly: 0.4.1(prettier@3.8.3) + prettier-plugin-ini: 1.3.0 + prettier-plugin-jsdoc: 1.8.0(prettier@3.8.3) + prettier-plugin-pkg: 0.22.1(prettier@3.8.3) + prettier-plugin-sh: 0.18.1(prettier@3.8.3) + prettier-plugin-sort-json: 4.2.0(prettier@3.8.3) + + '@humanfs/core@0.19.2': + dependencies: + '@humanfs/types': 0.15.0 + + '@humanfs/node@0.16.8': + dependencies: + '@humanfs/core': 0.19.2 + '@humanfs/types': 0.15.0 + '@humanwhocodes/retry': 0.4.3 + + '@humanfs/types@0.15.0': {} + + '@humanwhocodes/module-importer@1.0.1': {} + + '@humanwhocodes/retry@0.4.3': {} + + '@jridgewell/gen-mapping@0.3.13': + dependencies: + '@jridgewell/sourcemap-codec': 1.5.5 + '@jridgewell/trace-mapping': 0.3.31 + + '@jridgewell/remapping@2.3.5': + dependencies: + '@jridgewell/gen-mapping': 0.3.13 + '@jridgewell/trace-mapping': 0.3.31 + + '@jridgewell/resolve-uri@3.1.2': {} + + '@jridgewell/source-map@0.3.11': + dependencies: + '@jridgewell/gen-mapping': 0.3.13 + '@jridgewell/trace-mapping': 0.3.31 + + '@jridgewell/sourcemap-codec@1.5.5': {} + + '@jridgewell/trace-mapping@0.3.31': + dependencies: + '@jridgewell/resolve-uri': 3.1.2 + '@jridgewell/sourcemap-codec': 1.5.5 + + '@keyv/bigmap@1.3.1(keyv@5.6.0)': + dependencies: + hashery: 1.5.1 + hookified: 1.15.1 + keyv: 5.6.0 + + '@keyv/serialize@1.1.1': {} + + '@mobily/ts-belt@4.0.0-rc.5': {} + + '@msgpackr-extract/msgpackr-extract-linux-x64@3.0.3': {} + + '@nodelib/fs.scandir@2.1.5': + dependencies: + '@nodelib/fs.stat': 2.0.5 + run-parallel: 1.2.0 + + '@nodelib/fs.stat@2.0.5': {} + + '@nodelib/fs.walk@1.2.8': + dependencies: + '@nodelib/fs.scandir': 2.1.5 + fastq: 1.20.1 + + '@oxc-parser/binding-linux-x64-gnu@0.128.0': {} + + '@oxc-parser/binding-linux-x64-musl@0.128.0': {} + + '@oxc-project/types@0.127.0': {} + + '@oxc-project/types@0.128.0': {} + + '@oxc-resolver/binding-linux-x64-gnu@11.19.1': {} + + '@oxc-resolver/binding-linux-x64-musl@11.19.1': {} + + '@oxlint-tsgolint/linux-x64@0.22.1': {} + + '@oxlint/binding-linux-x64-gnu@1.62.0': {} + + '@oxlint/binding-linux-x64-musl@1.62.0': {} + + '@pkgr/core@0.2.9': {} + + '@playwright/test@1.59.1': + dependencies: + playwright: 1.59.1 + + '@reteps/dockerfmt@0.5.2': {} + + '@rolldown/binding-linux-x64-gnu@1.0.0-rc.17': {} + + '@rolldown/binding-linux-x64-musl@1.0.0-rc.17': {} + + '@rolldown/pluginutils@1.0.0-rc.17': {} + + '@sentry-internal/browser-utils@10.51.0': + dependencies: + '@sentry/core': 10.51.0 + + '@sentry-internal/feedback@10.51.0': + dependencies: + '@sentry/core': 10.51.0 + + '@sentry-internal/replay-canvas@10.51.0': + dependencies: + '@sentry-internal/replay': 10.51.0 + '@sentry/core': 10.51.0 + + '@sentry-internal/replay@10.51.0': + dependencies: + '@sentry-internal/browser-utils': 10.51.0 + '@sentry/core': 10.51.0 + + '@sentry/browser@10.51.0': + dependencies: + '@sentry-internal/browser-utils': 10.51.0 + '@sentry-internal/feedback': 10.51.0 + '@sentry-internal/replay': 10.51.0 + '@sentry-internal/replay-canvas': 10.51.0 + '@sentry/core': 10.51.0 + + '@sentry/core@10.51.0': {} + + '@sindresorhus/base62@1.0.0': {} + + '@sindresorhus/merge-streams@4.0.0': {} + + '@standard-schema/spec@1.1.0': {} + + '@stylistic/stylelint-plugin@5.1.0(stylelint@17.9.1)': + dependencies: + '@csstools/css-parser-algorithms': 4.0.0(@csstools/css-tokenizer@4.0.0) + '@csstools/css-tokenizer': 4.0.0 + '@csstools/media-query-list-parser': 5.0.0(@csstools/css-parser-algorithms@4.0.0(@csstools/css-tokenizer@4.0.0))(@csstools/css-tokenizer@4.0.0) + postcss: 8.5.12 + postcss-selector-parser: 7.1.1 + postcss-value-parser: 4.2.0 + style-search: 0.1.0 + stylelint: 17.9.1 + + '@types/bun@1.3.13': + dependencies: + bun-types: 1.3.13 + + '@types/debug@4.1.13': + dependencies: + '@types/ms': 2.1.0 + + '@types/esrecurse@4.3.1': {} + + '@types/estree@1.0.8': {} + + '@types/json-schema@7.0.15': {} + + '@types/mdast@4.0.4': + dependencies: + '@types/unist': 3.0.3 + + '@types/ms@2.1.0': {} + + '@types/node@25.6.0': + dependencies: + undici-types: 7.19.2 + + '@types/trusted-types@2.0.7': {} + + '@types/unist@3.0.3': {} + ? '@typescript-eslint/eslint-plugin@8.59.1(@typescript-eslint/parser@8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3))(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3)' + + : dependencies: + '@eslint-community/regexpp': 4.12.2 + '@typescript-eslint/parser': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + '@typescript-eslint/scope-manager': 8.59.1 + '@typescript-eslint/type-utils': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + '@typescript-eslint/utils': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + '@typescript-eslint/visitor-keys': 8.59.1 + eslint: 10.3.0(jiti@2.6.1) + ignore: 7.0.5 + natural-compare: 1.4.0 + ts-api-utils: 2.5.0(typescript@6.0.3) + typescript: 6.0.3 + + '@typescript-eslint/parser@8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3)': + dependencies: + '@typescript-eslint/scope-manager': 8.59.1 + '@typescript-eslint/types': 8.59.1 + '@typescript-eslint/typescript-estree': 8.59.1(typescript@6.0.3) + '@typescript-eslint/visitor-keys': 8.59.1 + debug: 4.4.3 + eslint: 10.3.0(jiti@2.6.1) + typescript: 6.0.3 + + '@typescript-eslint/project-service@8.59.1(typescript@6.0.3)': + dependencies: + '@typescript-eslint/tsconfig-utils': 8.59.1(typescript@6.0.3) + '@typescript-eslint/types': 8.59.1 + debug: 4.4.3 + typescript: 6.0.3 + + '@typescript-eslint/scope-manager@8.59.1': + dependencies: + '@typescript-eslint/types': 8.59.1 + '@typescript-eslint/visitor-keys': 8.59.1 + + '@typescript-eslint/tsconfig-utils@8.59.1(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript-eslint/type-utils@8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3)': + dependencies: + '@typescript-eslint/types': 8.59.1 + '@typescript-eslint/typescript-estree': 8.59.1(typescript@6.0.3) + '@typescript-eslint/utils': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + debug: 4.4.3 + eslint: 10.3.0(jiti@2.6.1) + ts-api-utils: 2.5.0(typescript@6.0.3) + typescript: 6.0.3 + + '@typescript-eslint/types@8.59.1': {} + + '@typescript-eslint/typescript-estree@8.59.1(typescript@6.0.3)': + dependencies: + '@typescript-eslint/project-service': 8.59.1(typescript@6.0.3) + '@typescript-eslint/tsconfig-utils': 8.59.1(typescript@6.0.3) + '@typescript-eslint/types': 8.59.1 + '@typescript-eslint/visitor-keys': 8.59.1 + debug: 4.4.3 + minimatch: 10.2.5 + semver: 7.7.4 + tinyglobby: 0.2.16 + ts-api-utils: 2.5.0(typescript@6.0.3) + typescript: 6.0.3 + + '@typescript-eslint/utils@8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3)': + dependencies: + '@eslint-community/eslint-utils': 4.9.1(eslint@10.3.0(jiti@2.6.1)) + '@typescript-eslint/scope-manager': 8.59.1 + '@typescript-eslint/types': 8.59.1 + '@typescript-eslint/typescript-estree': 8.59.1(typescript@6.0.3) + eslint: 10.3.0(jiti@2.6.1) + typescript: 6.0.3 + + '@typescript-eslint/visitor-keys@8.59.1': + dependencies: + '@typescript-eslint/types': 8.59.1 + eslint-visitor-keys: 5.0.1 + + '@typescript/lib-decorators@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-dom@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2015@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2016@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2017@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2018@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2019@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2020@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2021@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2022@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2023@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es2024@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es5@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-es6@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-esnext@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-scripthost@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/lib-webworker@2.12.0(typescript@6.0.3)': + dependencies: + typescript: 6.0.3 + + '@typescript/native-preview-linux-x64@7.0.0-dev.20260503.1': {} + + '@typescript/native-preview@7.0.0-dev.20260503.1': + optionalDependencies: + '@typescript/native-preview-linux-x64': 7.0.0-dev.20260503.1 + ? '@vitejs/plugin-legacy@8.0.1(terser@5.46.2)(vite@8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3))' + + : dependencies: + '@babel/core': 7.29.0 + '@babel/plugin-transform-dynamic-import': 7.27.1(@babel/core@7.29.0) + '@babel/plugin-transform-modules-systemjs': 7.29.0(@babel/core@7.29.0) + '@babel/preset-env': 7.29.2(@babel/core@7.29.0) + babel-plugin-polyfill-corejs3: 0.14.2(@babel/core@7.29.0) + babel-plugin-polyfill-regenerator: 0.6.8(@babel/core@7.29.0) + browserslist: 4.28.2 + browserslist-to-esbuild: 2.1.1(browserslist@4.28.2) + core-js: 3.49.0 + magic-string: 0.30.21 + regenerator-runtime: 0.14.1 + systemjs: 6.15.1 + terser: 5.46.2 + vite: 8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3) + + a11y-dialog@8.1.5: + dependencies: + focusable-selectors: 0.8.4 + + acorn-jsx@5.3.2(acorn@8.16.0): + dependencies: + acorn: 8.16.0 + + acorn@8.16.0: {} + + ajv@6.15.0: + dependencies: + fast-deep-equal: 3.1.3 + fast-json-stable-stringify: 2.1.0 + json-schema-traverse: 0.4.1 + uri-js: 4.4.1 + + ajv@8.20.0: + dependencies: + fast-deep-equal: 3.1.3 + fast-uri: 3.1.0 + json-schema-traverse: 1.0.0 + require-from-string: 2.0.2 + + ansi-regex@5.0.1: {} + + ansi-regex@6.2.2: {} + + ansi-styles@4.3.0: + dependencies: + color-convert: 2.0.1 + + are-docs-informative@0.0.2: {} + + argparse@2.0.1: {} + + aria-query@5.3.2: {} + + array-buffer-byte-length@1.0.2: + dependencies: + call-bound: 1.0.4 + is-array-buffer: 3.0.5 + + array-includes@3.1.9: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + define-properties: 1.2.1 + es-abstract: 1.24.2 + es-object-atoms: 1.1.1 + get-intrinsic: 1.3.1 + is-string: 1.1.1 + math-intrinsics: 1.1.0 + + array.prototype.flat@1.3.3: + dependencies: + call-bind: 1.0.9 + define-properties: 1.2.1 + es-abstract: 1.24.2 + es-shim-unscopables: 1.1.0 + + array.prototype.flatmap@1.3.3: + dependencies: + call-bind: 1.0.9 + define-properties: 1.2.1 + es-abstract: 1.24.2 + es-shim-unscopables: 1.1.0 + + arraybuffer.prototype.slice@1.0.4: + dependencies: + array-buffer-byte-length: 1.0.2 + call-bind: 1.0.9 + define-properties: 1.2.1 + es-abstract: 1.24.2 + es-errors: 1.3.0 + get-intrinsic: 1.3.1 + is-array-buffer: 3.0.5 + + ast-types-flow@0.0.8: {} + + astral-regex@2.0.0: {} + + astro-eslint-parser@1.4.0: + dependencies: + '@astrojs/compiler': 3.0.1 + '@typescript-eslint/scope-manager': 8.59.1 + '@typescript-eslint/types': 8.59.1 + astrojs-compiler-sync: 1.1.1(@astrojs/compiler@3.0.1) + debug: 4.4.3 + entities: 7.0.1 + eslint-scope: 8.4.0 + eslint-visitor-keys: 4.2.1 + espree: 10.4.0 + fast-glob: 3.3.3 + is-glob: 4.0.3 + semver: 7.7.4 + + astrojs-compiler-sync@1.1.1(@astrojs/compiler@3.0.1): + dependencies: + '@astrojs/compiler': 3.0.1 + synckit: 0.11.12 + + async-function@1.0.0: {} + + async-generator-function@1.0.0: {} + + available-typed-arrays@1.0.7: + dependencies: + possible-typed-array-names: 1.1.0 + + axe-core@4.11.3: {} + + axobject-query@4.1.0: {} + + babel-plugin-polyfill-corejs2@0.4.17(@babel/core@7.29.0): + dependencies: + '@babel/compat-data': 7.29.0 + '@babel/core': 7.29.0 + '@babel/helper-define-polyfill-provider': 0.6.8(@babel/core@7.29.0) + semver: 6.3.1 + + babel-plugin-polyfill-corejs3@0.14.2(@babel/core@7.29.0): + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-define-polyfill-provider': 0.6.8(@babel/core@7.29.0) + core-js-compat: 3.49.0 + + babel-plugin-polyfill-regenerator@0.6.8(@babel/core@7.29.0): + dependencies: + '@babel/core': 7.29.0 + '@babel/helper-define-polyfill-provider': 0.6.8(@babel/core@7.29.0) + + balanced-match@1.0.2: {} + + balanced-match@4.0.4: {} + + baseline-browser-mapping@2.10.24: {} + + better-typescript-lib@2.12.0(typescript@6.0.3): + dependencies: + '@typescript/lib-decorators': 2.12.0(typescript@6.0.3) + '@typescript/lib-dom': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2015': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2016': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2017': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2018': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2019': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2020': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2021': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2022': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2023': 2.12.0(typescript@6.0.3) + '@typescript/lib-es2024': 2.12.0(typescript@6.0.3) + '@typescript/lib-es5': 2.12.0(typescript@6.0.3) + '@typescript/lib-es6': 2.12.0(typescript@6.0.3) + '@typescript/lib-esnext': 2.12.0(typescript@6.0.3) + '@typescript/lib-scripthost': 2.12.0(typescript@6.0.3) + '@typescript/lib-webworker': 2.12.0(typescript@6.0.3) + typescript: 6.0.3 + + binary-searching@2.0.5: {} + + brace-expansion@1.1.14: + dependencies: + balanced-match: 1.0.2 + concat-map: 0.0.1 + + brace-expansion@5.0.5: + dependencies: + balanced-match: 4.0.4 + + braces@3.0.3: + dependencies: + fill-range: 7.1.1 + + browserslist-to-esbuild@2.1.1(browserslist@4.28.2): + dependencies: + browserslist: 4.28.2 + meow: 13.2.0 + + browserslist@4.28.2: + dependencies: + baseline-browser-mapping: 2.10.24 + caniuse-lite: 1.0.30001791 + electron-to-chromium: 1.5.344 + node-releases: 2.0.38 + update-browserslist-db: 1.2.3(browserslist@4.28.2) + + buffer-from@1.1.2: {} + + builtin-modules@3.3.0: {} + + builtin-modules@5.1.0: {} + + bun-types@1.3.13: + dependencies: + '@types/node': 25.6.0 + + bytes@3.1.2: {} + + cacheable@2.3.4: + dependencies: + '@cacheable/memory': 2.0.8 + '@cacheable/utils': 2.4.1 + hookified: 1.15.1 + keyv: 5.6.0 + qified: 0.9.1 + + call-bind-apply-helpers@1.0.2: + dependencies: + es-errors: 1.3.0 + function-bind: 1.1.2 + + call-bind@1.0.9: + dependencies: + call-bind-apply-helpers: 1.0.2 + es-define-property: 1.0.1 + get-intrinsic: 1.3.1 + set-function-length: 1.2.2 + + call-bound@1.0.4: + dependencies: + call-bind-apply-helpers: 1.0.2 + get-intrinsic: 1.3.1 + + callsites@3.1.0: {} + + caniuse-lite@1.0.30001791: {} + + change-case@5.4.4: {} + + character-entities@2.0.2: {} + + ci-info@4.4.0: {} + + clean-regexp@1.0.0: + dependencies: + escape-string-regexp: 1.0.5 + + color-convert@2.0.1: + dependencies: + color-name: 1.1.4 + + color-name@1.1.4: {} + + colord@2.9.3: {} + + colorjs.io@0.5.2: {} + + commander@2.20.3: {} + + comment-parser@1.4.6: {} + + concat-map@0.0.1: {} + + convert-source-map@2.0.0: {} + + core-js-compat@3.49.0: + dependencies: + browserslist: 4.28.2 + + core-js@3.49.0: {} + + cosmiconfig@9.0.1(typescript@6.0.3): + dependencies: + env-paths: 2.2.1 + import-fresh: 3.3.1 + js-yaml: 4.1.1 + parse-json: 5.2.0 + typescript: 6.0.3 + + cross-spawn@7.0.6: + dependencies: + path-key: 3.1.1 + shebang-command: 2.0.0 + which: 2.0.2 + + css-functions-list@3.3.3: {} + + css-tree@3.2.1: + dependencies: + mdn-data: 2.27.1 + source-map-js: 1.2.1 + + cssesc@3.0.0: {} + + damerau-levenshtein@1.0.8: {} + + data-view-buffer@1.0.2: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + is-data-view: 1.0.2 + + data-view-byte-length@1.0.2: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + is-data-view: 1.0.2 + + data-view-byte-offset@1.0.1: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + is-data-view: 1.0.2 + + debug@4.4.3: + dependencies: + ms: 2.1.3 + + decode-named-character-reference@1.3.0: + dependencies: + character-entities: 2.0.2 + + deep-is@0.1.4: {} + + deepmerge-ts@7.1.5: {} + + define-data-property@1.1.4: + dependencies: + es-define-property: 1.0.1 + es-errors: 1.3.0 + gopd: 1.2.0 + + define-properties@1.2.1: + dependencies: + define-data-property: 1.1.4 + has-property-descriptors: 1.0.2 + object-keys: 1.1.1 + + dequal@2.0.3: {} + + detect-libc@2.1.2: {} + + devlop@1.1.0: + dependencies: + dequal: 2.0.3 + + dunder-proto@1.0.1: + dependencies: + call-bind-apply-helpers: 1.0.2 + es-errors: 1.3.0 + gopd: 1.2.0 + + effect@4.0.0-beta.59: + dependencies: + '@standard-schema/spec': 1.1.0 + fast-check: 4.7.0 + find-my-way-ts: 0.1.6 + ini: 6.0.0 + kubernetes-types: 1.30.0 + msgpackr: 1.11.10 + multipasta: 0.2.7 + toml: 4.1.1 + uuid: 13.0.0 + yaml: 2.8.3 + + electron-to-chromium@1.5.344: {} + + emoji-regex@8.0.0: {} + + emoji-regex@9.2.2: {} + + entities@7.0.1: {} + + env-paths@2.2.1: {} + + error-ex@1.3.4: + dependencies: + is-arrayish: 0.2.1 + + 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.9 + 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.1 + 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.3 + 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.4 + 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.20 + + es-define-property@1.0.1: {} + + es-errors@1.3.0: {} + + es-object-atoms@1.1.1: + dependencies: + es-errors: 1.3.0 + + es-set-tostringtag@2.1.0: + dependencies: + es-errors: 1.3.0 + get-intrinsic: 1.3.1 + has-tostringtag: 1.0.2 + hasown: 2.0.3 + + es-shim-unscopables@1.1.0: + dependencies: + hasown: 2.0.3 + + es-to-primitive@1.3.0: + dependencies: + is-callable: 1.2.7 + is-date-object: 1.1.0 + is-symbol: 1.1.1 + + escalade@3.2.0: {} + + escape-string-regexp@1.0.5: {} + + escape-string-regexp@4.0.0: {} + + escape-string-regexp@5.0.0: {} + + eslint-compat-utils@0.6.5(eslint@10.3.0(jiti@2.6.1)): + dependencies: + eslint: 10.3.0(jiti@2.6.1) + semver: 7.7.4 + + eslint-plugin-astro@1.7.0(eslint@10.3.0(jiti@2.6.1)): + dependencies: + '@eslint-community/eslint-utils': 4.9.1(eslint@10.3.0(jiti@2.6.1)) + '@jridgewell/sourcemap-codec': 1.5.5 + '@typescript-eslint/types': 8.59.1 + astro-eslint-parser: 1.4.0 + eslint: 10.3.0(jiti@2.6.1) + eslint-compat-utils: 0.6.5(eslint@10.3.0(jiti@2.6.1)) + globals: 16.5.0 + postcss: 8.5.12 + postcss-selector-parser: 7.1.1 + + eslint-plugin-functional@9.0.4(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3): + dependencies: + '@typescript-eslint/utils': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + deepmerge-ts: 7.1.5 + escape-string-regexp: 5.0.0 + eslint: 10.3.0(jiti@2.6.1) + is-immutable-type: 5.0.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + ts-api-utils: 2.5.0(typescript@6.0.3) + ts-declaration-location: 1.0.7(typescript@6.0.3) + typescript: 6.0.3 + + eslint-plugin-jsdoc@62.9.0(eslint@10.3.0(jiti@2.6.1)): + dependencies: + '@es-joy/jsdoccomment': 0.86.0 + '@es-joy/resolve.exports': 1.2.0 + are-docs-informative: 0.0.2 + comment-parser: 1.4.6 + debug: 4.4.3 + escape-string-regexp: 4.0.0 + eslint: 10.3.0(jiti@2.6.1) + espree: 11.2.0 + esquery: 1.7.0 + html-entities: 2.6.0 + object-deep-merge: 2.0.0 + parse-imports-exports: 0.2.4 + semver: 7.7.4 + spdx-expression-parse: 4.0.0 + to-valid-identifier: 1.0.0 + + eslint-plugin-jsx-a11y@6.10.2(eslint@10.3.0(jiti@2.6.1)): + dependencies: + aria-query: 5.3.2 + array-includes: 3.1.9 + array.prototype.flatmap: 1.3.3 + ast-types-flow: 0.0.8 + axe-core: 4.11.3 + axobject-query: 4.1.0 + damerau-levenshtein: 1.0.8 + emoji-regex: 9.2.2 + eslint: 10.3.0(jiti@2.6.1) + hasown: 2.0.3 + jsx-ast-utils: 3.3.5 + language-tags: 1.0.9 + minimatch: 3.1.5 + object.fromentries: 2.0.8 + safe-regex-test: 1.1.0 + string.prototype.includes: 2.0.1 + + eslint-plugin-oxlint@1.62.0(oxlint@1.62.0(oxlint-tsgolint@0.22.1)): + dependencies: + jsonc-parser: 3.3.1 + oxlint: 1.62.0(oxlint-tsgolint@0.22.1) + + eslint-plugin-perfectionist@5.9.0(eslint@10.3.0(jiti@2.6.1)): + dependencies: + '@typescript-eslint/utils': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + eslint: 10.3.0(jiti@2.6.1) + natural-orderby: 5.0.0 + + eslint-plugin-sonarjs@4.0.3(eslint@10.3.0(jiti@2.6.1)): + dependencies: + '@eslint-community/regexpp': 4.12.2 + builtin-modules: 3.3.0 + bytes: 3.1.2 + eslint: 10.3.0(jiti@2.6.1) + functional-red-black-tree: 1.0.1 + globals: 17.5.0 + jsx-ast-utils-x: 0.1.0 + lodash.merge: 4.6.2 + minimatch: 10.2.5 + scslre: 0.3.0 + semver: 7.7.4 + ts-api-utils: 2.5.0(typescript@6.0.3) + typescript: 6.0.3 + + eslint-plugin-unicorn@64.0.0(eslint@10.3.0(jiti@2.6.1)): + dependencies: + '@babel/helper-validator-identifier': 7.28.5 + '@eslint-community/eslint-utils': 4.9.1(eslint@10.3.0(jiti@2.6.1)) + change-case: 5.4.4 + ci-info: 4.4.0 + clean-regexp: 1.0.0 + core-js-compat: 3.49.0 + eslint: 10.3.0(jiti@2.6.1) + find-up-simple: 1.0.1 + globals: 17.5.0 + indent-string: 5.0.0 + is-builtin-module: 5.0.0 + jsesc: 3.1.0 + pluralize: 8.0.0 + regexp-tree: 0.1.27 + regjsparser: 0.13.1 + semver: 7.7.4 + strip-indent: 4.1.1 + + eslint-scope@8.4.0: + dependencies: + esrecurse: 4.3.0 + estraverse: 5.3.0 + + eslint-scope@9.1.2: + dependencies: + '@types/esrecurse': 4.3.1 + '@types/estree': 1.0.8 + esrecurse: 4.3.0 + estraverse: 5.3.0 + + eslint-visitor-keys@3.4.3: {} + + eslint-visitor-keys@4.2.1: {} + + eslint-visitor-keys@5.0.1: {} + + eslint@10.3.0(jiti@2.6.1): + dependencies: + '@eslint-community/eslint-utils': 4.9.1(eslint@10.3.0(jiti@2.6.1)) + '@eslint-community/regexpp': 4.12.2 + '@eslint/config-array': 0.23.5 + '@eslint/config-helpers': 0.5.5 + '@eslint/core': 1.2.1 + '@eslint/plugin-kit': 0.7.1 + '@humanfs/node': 0.16.8 + '@humanwhocodes/module-importer': 1.0.1 + '@humanwhocodes/retry': 0.4.3 + '@types/estree': 1.0.8 + ajv: 6.15.0 + cross-spawn: 7.0.6 + debug: 4.4.3 + 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.3 + fast-deep-equal: 3.1.3 + file-entry-cache: 8.0.0 + find-up: 5.0.0 + glob-parent: 6.0.2 + ignore: 5.3.2 + imurmurhash: 0.1.4 + is-glob: 4.0.3 + jiti: 2.6.1 + json-stable-stringify-without-jsonify: 1.0.1 + minimatch: 10.2.5 + natural-compare: 1.4.0 + optionator: 0.9.4 + + espree@10.4.0: + dependencies: + acorn: 8.16.0 + acorn-jsx: 5.3.2(acorn@8.16.0) + eslint-visitor-keys: 4.2.1 + + espree@11.2.0: + dependencies: + acorn: 8.16.0 + acorn-jsx: 5.3.2(acorn@8.16.0) + eslint-visitor-keys: 5.0.1 + + esquery@1.7.0: + dependencies: + estraverse: 5.3.0 + + esrecurse@4.3.0: + dependencies: + estraverse: 5.3.0 + + estraverse@5.3.0: {} + + esutils@2.0.3: {} + + fast-check@4.7.0: + dependencies: + pure-rand: 8.4.0 + + fast-deep-equal@3.1.3: {} + + fast-glob@3.3.3: + dependencies: + '@nodelib/fs.stat': 2.0.5 + '@nodelib/fs.walk': 1.2.8 + glob-parent: 5.1.2 + merge2: 1.4.1 + micromatch: 4.0.8 + + fast-json-stable-stringify@2.1.0: {} + + fast-levenshtein@2.0.6: {} + + fast-uri@3.1.0: {} + + fastest-levenshtein@1.0.16: {} + + fastq@1.20.1: + dependencies: + reusify: 1.1.0 + + fd-package-json@2.0.0: + dependencies: + walk-up-path: 4.0.0 + + fdir@6.5.0(picomatch@4.0.4): + dependencies: + picomatch: 4.0.4 + + file-entry-cache@11.1.2: + dependencies: + flat-cache: 6.1.22 + + file-entry-cache@8.0.0: + dependencies: + flat-cache: 4.0.1 + + fill-range@7.1.1: + dependencies: + to-regex-range: 5.0.1 + + find-my-way-ts@0.1.6: {} + + find-up-simple@1.0.1: {} + + find-up@5.0.0: + dependencies: + locate-path: 6.0.0 + path-exists: 4.0.0 + + flat-cache@4.0.1: + dependencies: + flatted: 3.4.2 + keyv: 4.5.4 + + flat-cache@6.1.22: + dependencies: + cacheable: 2.3.4 + flatted: 3.4.2 + hookified: 1.15.1 + + flatted@3.4.2: {} + + focusable-selectors@0.8.4: {} + + for-each@0.3.5: + dependencies: + is-callable: 1.2.7 + + formatly@0.3.0: + dependencies: + fd-package-json: 2.0.0 + + function-bind@1.1.2: {} + + function.prototype.name@1.1.8: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + define-properties: 1.2.1 + functions-have-names: 1.2.3 + hasown: 2.0.3 + is-callable: 1.2.7 + + functional-red-black-tree@1.0.1: {} + + functions-have-names@1.2.3: {} + + generator-function@2.0.1: {} + + gensync@1.0.0-beta.2: {} + + get-east-asian-width@1.5.0: {} + + get-intrinsic@1.3.1: + dependencies: + async-function: 1.0.0 + async-generator-function: 1.0.0 + call-bind-apply-helpers: 1.0.2 + es-define-property: 1.0.1 + es-errors: 1.3.0 + es-object-atoms: 1.1.1 + function-bind: 1.1.2 + generator-function: 2.0.1 + get-proto: 1.0.1 + gopd: 1.2.0 + has-symbols: 1.1.0 + hasown: 2.0.3 + math-intrinsics: 1.1.0 + + get-proto@1.0.1: + dependencies: + dunder-proto: 1.0.1 + es-object-atoms: 1.1.1 + + get-symbol-description@1.1.0: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + get-intrinsic: 1.3.1 + + get-tsconfig@4.14.0: + dependencies: + resolve-pkg-maps: 1.0.0 + + glob-parent@5.1.2: + dependencies: + is-glob: 4.0.3 + + glob-parent@6.0.2: + dependencies: + is-glob: 4.0.3 + + global-modules@2.0.0: + dependencies: + global-prefix: 3.0.0 + + global-prefix@3.0.0: + dependencies: + ini: 1.3.8 + kind-of: 6.0.3 + which: 1.3.1 + + globals@16.5.0: {} + + globals@17.5.0: {} + + globals@17.6.0: {} + + globalthis@1.0.4: + dependencies: + define-properties: 1.2.1 + gopd: 1.2.0 + + globby@16.2.0: + dependencies: + '@sindresorhus/merge-streams': 4.0.0 + fast-glob: 3.3.3 + ignore: 7.0.5 + is-path-inside: 4.0.0 + slash: 5.1.0 + unicorn-magic: 0.4.0 + + globjoin@0.1.4: {} + + globrex@0.1.2: {} + + gopd@1.2.0: {} + + has-bigints@1.1.0: {} + + has-flag@4.0.0: {} + + has-flag@5.0.1: {} + + has-property-descriptors@1.0.2: + dependencies: + es-define-property: 1.0.1 + + has-proto@1.2.0: + dependencies: + dunder-proto: 1.0.1 + + has-symbols@1.1.0: {} + + has-tostringtag@1.0.2: + dependencies: + has-symbols: 1.1.0 + + hashery@1.5.1: + dependencies: + hookified: 1.15.1 + + hasown@2.0.3: + dependencies: + function-bind: 1.1.2 + + hookified@1.15.1: {} + + hookified@2.2.0: {} + + html-element-attributes@3.5.0: {} + + html-entities@2.6.0: {} + + html-es6cape@2.0.2: {} + + html-tags@5.1.0: {} + + html-template-tag@5.0.0: + dependencies: + html-element-attributes: 3.5.0 + html-es6cape: 2.0.2 + + ignore@5.3.2: {} + + ignore@7.0.5: {} + + immutable@5.1.5: {} + + import-fresh@3.3.1: + dependencies: + parent-module: 1.0.1 + resolve-from: 4.0.0 + + import-meta-resolve@4.2.0: {} + + imurmurhash@0.1.4: {} + + indent-string@5.0.0: {} + + ini@1.3.8: {} + + ini@6.0.0: {} + + internal-slot@1.1.0: + dependencies: + es-errors: 1.3.0 + hasown: 2.0.3 + side-channel: 1.1.0 + + is-array-buffer@3.0.5: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + get-intrinsic: 1.3.1 + + is-arrayish@0.2.1: {} + + is-async-function@2.1.1: + dependencies: + async-function: 1.0.0 + call-bound: 1.0.4 + get-proto: 1.0.1 + has-tostringtag: 1.0.2 + safe-regex-test: 1.1.0 + + is-bigint@1.1.0: + dependencies: + has-bigints: 1.1.0 + + is-boolean-object@1.2.2: + dependencies: + call-bound: 1.0.4 + has-tostringtag: 1.0.2 + + is-builtin-module@5.0.0: + dependencies: + builtin-modules: 5.1.0 + + is-callable@1.2.7: {} + + is-core-module@2.16.1: + dependencies: + hasown: 2.0.3 + + is-data-view@1.0.2: + dependencies: + call-bound: 1.0.4 + get-intrinsic: 1.3.1 + is-typed-array: 1.1.15 + + is-date-object@1.1.0: + dependencies: + call-bound: 1.0.4 + has-tostringtag: 1.0.2 + + is-extglob@2.1.1: {} + + is-finalizationregistry@1.1.1: + dependencies: + call-bound: 1.0.4 + + is-fullwidth-code-point@3.0.0: {} + + is-generator-function@1.1.2: + dependencies: + call-bound: 1.0.4 + generator-function: 2.0.1 + get-proto: 1.0.1 + has-tostringtag: 1.0.2 + safe-regex-test: 1.1.0 + + is-glob@4.0.3: + dependencies: + is-extglob: 2.1.1 + + is-immutable-type@5.0.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3): + dependencies: + '@typescript-eslint/type-utils': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + eslint: 10.3.0(jiti@2.6.1) + ts-api-utils: 2.5.0(typescript@6.0.3) + ts-declaration-location: 1.0.7(typescript@6.0.3) + typescript: 6.0.3 + + is-map@2.0.3: {} + + is-negative-zero@2.0.3: {} + + is-number-object@1.1.1: + dependencies: + call-bound: 1.0.4 + has-tostringtag: 1.0.2 + + is-number@7.0.0: {} + + is-path-inside@4.0.0: {} + + is-plain-object@5.0.0: {} + + is-regex@1.2.1: + dependencies: + call-bound: 1.0.4 + gopd: 1.2.0 + has-tostringtag: 1.0.2 + hasown: 2.0.3 + + is-set@2.0.3: {} + + is-shared-array-buffer@1.0.4: + dependencies: + call-bound: 1.0.4 + + is-string@1.1.1: + dependencies: + call-bound: 1.0.4 + has-tostringtag: 1.0.2 + + is-symbol@1.1.1: + dependencies: + call-bound: 1.0.4 + has-symbols: 1.1.0 + safe-regex-test: 1.1.0 + + is-typed-array@1.1.15: + dependencies: + which-typed-array: 1.1.20 + + is-weakmap@2.0.2: {} + + is-weakref@1.1.1: + dependencies: + call-bound: 1.0.4 + + is-weakset@2.0.4: + dependencies: + call-bound: 1.0.4 + get-intrinsic: 1.3.1 + + isarray@2.0.5: {} + + isexe@2.0.0: {} + + jiti@2.6.1: {} + + js-tokens@4.0.0: {} + + js-yaml@4.1.1: + dependencies: + argparse: 2.0.1 + + jsdoc-type-pratt-parser@7.2.0: {} + + jsesc@3.1.0: {} + + json-buffer@3.0.1: {} + + json-parse-even-better-errors@2.3.1: {} + + json-schema-traverse@0.4.1: {} + + json-schema-traverse@1.0.0: {} + + json-stable-stringify-without-jsonify@1.0.1: {} + + json5@2.2.3: {} + + jsonc-parser@3.3.1: {} + + jsx-ast-utils-x@0.1.0: {} + + jsx-ast-utils@3.3.5: + dependencies: + array-includes: 3.1.9 + array.prototype.flat: 1.3.3 + object.assign: 4.1.7 + object.values: 1.2.1 + + keyv@4.5.4: + dependencies: + json-buffer: 3.0.1 + + keyv@5.6.0: + dependencies: + '@keyv/serialize': 1.1.1 + + kind-of@6.0.3: {} + + knip@6.11.0: + dependencies: + fdir: 6.5.0(picomatch@4.0.4) + formatly: 0.3.0 + get-tsconfig: 4.14.0 + jiti: 2.6.1 + minimist: 1.2.8 + oxc-parser: 0.128.0 + oxc-resolver: 11.19.1 + picomatch: 4.0.4 + smol-toml: 1.6.1 + strip-json-comments: 5.0.3 + tinyglobby: 0.2.16 + unbash: 3.0.0 + yaml: 2.8.3 + zod: 4.3.6 + + known-css-properties@0.37.0: {} + + kubernetes-types@1.30.0: {} + + language-subtag-registry@0.3.23: {} + + language-tags@1.0.9: + dependencies: + language-subtag-registry: 0.3.23 + + levn@0.4.1: + dependencies: + prelude-ls: 1.2.1 + type-check: 0.4.0 + + lightningcss-cli-linux-x64-gnu@1.32.0: {} + + lightningcss-cli-linux-x64-musl@1.32.0: {} + + lightningcss-cli@1.32.0: + dependencies: + detect-libc: 2.1.2 + optionalDependencies: + lightningcss-cli-linux-x64-gnu: 1.32.0 + lightningcss-cli-linux-x64-musl: 1.32.0 + + lightningcss-linux-x64-gnu@1.32.0: {} + + lightningcss-linux-x64-musl@1.32.0: {} + + lightningcss@1.32.0: + dependencies: + detect-libc: 2.1.2 + optionalDependencies: + lightningcss-linux-x64-gnu: 1.32.0 + lightningcss-linux-x64-musl: 1.32.0 + + lines-and-columns@1.2.4: {} + + lit-html@3.3.2: + dependencies: + '@types/trusted-types': 2.0.7 + + locate-path@6.0.0: + dependencies: + p-locate: 5.0.0 + + lodash.debounce@4.0.8: {} + + lodash.merge@4.6.2: {} + + lodash.truncate@4.4.2: {} + + lru-cache@5.1.1: + dependencies: + yallist: 3.1.1 + + magic-string@0.30.21: + dependencies: + '@jridgewell/sourcemap-codec': 1.5.5 + + math-intrinsics@1.1.0: {} + + mathml-tag-names@4.0.0: {} + + mdast-util-from-markdown@2.0.3: + dependencies: + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 + decode-named-character-reference: 1.3.0 + devlop: 1.1.0 + mdast-util-to-string: 4.0.0 + micromark: 4.0.2 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-decode-string: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + unist-util-stringify-position: 4.0.0 + + mdast-util-to-string@4.0.0: + dependencies: + '@types/mdast': 4.0.4 + + mdn-data@2.27.1: {} + + meow@13.2.0: {} + + meow@14.1.0: {} + + merge2@1.4.1: {} + + micromark-core-commonmark@2.0.3: + dependencies: + decode-named-character-reference: 1.3.0 + devlop: 1.1.0 + micromark-factory-destination: 2.0.1 + micromark-factory-label: 2.0.1 + micromark-factory-space: 2.0.1 + micromark-factory-title: 2.0.1 + micromark-factory-whitespace: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-chunked: 2.0.1 + micromark-util-classify-character: 2.0.1 + micromark-util-html-tag-name: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-subtokenize: 2.1.0 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-factory-destination@2.0.1: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-factory-label@2.0.1: + dependencies: + devlop: 1.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-factory-space@2.0.1: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-types: 2.0.2 + + micromark-factory-title@2.0.1: + dependencies: + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-factory-whitespace@2.0.1: + dependencies: + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-util-character@2.1.1: + dependencies: + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-util-chunked@2.0.1: + dependencies: + micromark-util-symbol: 2.0.1 + + micromark-util-classify-character@2.0.1: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-util-combine-extensions@2.0.1: + dependencies: + micromark-util-chunked: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-util-decode-numeric-character-reference@2.0.2: + dependencies: + micromark-util-symbol: 2.0.1 + + micromark-util-decode-string@2.0.1: + dependencies: + decode-named-character-reference: 1.3.0 + micromark-util-character: 2.1.1 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-symbol: 2.0.1 + + micromark-util-encode@2.0.1: {} + + micromark-util-html-tag-name@2.0.1: {} + + micromark-util-normalize-identifier@2.0.1: + dependencies: + micromark-util-symbol: 2.0.1 + + micromark-util-resolve-all@2.0.1: + dependencies: + micromark-util-types: 2.0.2 + + micromark-util-sanitize-uri@2.0.1: + dependencies: + micromark-util-character: 2.1.1 + micromark-util-encode: 2.0.1 + micromark-util-symbol: 2.0.1 + + micromark-util-subtokenize@2.1.0: + dependencies: + devlop: 1.1.0 + micromark-util-chunked: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromark-util-symbol@2.0.1: {} + + micromark-util-types@2.0.2: {} + + micromark@4.0.2: + dependencies: + '@types/debug': 4.1.13 + debug: 4.4.3 + decode-named-character-reference: 1.3.0 + devlop: 1.1.0 + micromark-core-commonmark: 2.0.3 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-chunked: 2.0.1 + micromark-util-combine-extensions: 2.0.1 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-encode: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-sanitize-uri: 2.0.1 + micromark-util-subtokenize: 2.1.0 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.2 + + micromatch@4.0.8: + dependencies: + braces: 3.0.3 + picomatch: 2.3.2 + + minimatch@10.2.5: + dependencies: + brace-expansion: 5.0.5 + + minimatch@3.1.5: + dependencies: + brace-expansion: 1.1.14 + + minimist@1.2.8: {} + + ms@2.1.3: {} + + msgpackr-extract@3.0.3: + dependencies: + node-gyp-build-optional-packages: 5.2.2 + optionalDependencies: + '@msgpackr-extract/msgpackr-extract-linux-x64': 3.0.3 + + msgpackr@1.11.10: + optionalDependencies: + msgpackr-extract: 3.0.3 + + multipasta@0.2.7: {} + + nanoid@3.3.11: {} + + natural-compare@1.4.0: {} + + natural-orderby@5.0.0: {} + + node-gyp-build-optional-packages@5.2.2: + dependencies: + detect-libc: 2.1.2 + + node-releases@2.0.38: {} + + normalize-path@3.0.0: {} + + object-deep-merge@2.0.0: {} + + object-inspect@1.13.4: {} + + object-keys@1.1.1: {} + + object.assign@4.1.7: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + define-properties: 1.2.1 + es-object-atoms: 1.1.1 + has-symbols: 1.1.0 + object-keys: 1.1.1 + + object.fromentries@2.0.8: + dependencies: + call-bind: 1.0.9 + define-properties: 1.2.1 + es-abstract: 1.24.2 + es-object-atoms: 1.1.1 + + object.values@1.2.1: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + define-properties: 1.2.1 + es-object-atoms: 1.1.1 + + optionator@0.9.4: + dependencies: + deep-is: 0.1.4 + fast-levenshtein: 2.0.6 + levn: 0.4.1 + prelude-ls: 1.2.1 + type-check: 0.4.0 + word-wrap: 1.2.5 + + own-keys@1.0.1: + dependencies: + get-intrinsic: 1.3.1 + object-keys: 1.1.1 + safe-push-apply: 1.0.0 + + oxc-parser@0.128.0: + dependencies: + '@oxc-project/types': 0.128.0 + optionalDependencies: + '@oxc-parser/binding-linux-x64-gnu': 0.128.0 + '@oxc-parser/binding-linux-x64-musl': 0.128.0 + + oxc-resolver@11.19.1: + optionalDependencies: + '@oxc-resolver/binding-linux-x64-gnu': 11.19.1 + '@oxc-resolver/binding-linux-x64-musl': 11.19.1 + + oxlint-tsgolint@0.22.1: + optionalDependencies: + '@oxlint-tsgolint/linux-x64': 0.22.1 + + oxlint@1.62.0(oxlint-tsgolint@0.22.1): + dependencies: + oxlint-tsgolint: 0.22.1 + optionalDependencies: + '@oxlint/binding-linux-x64-gnu': 1.62.0 + '@oxlint/binding-linux-x64-musl': 1.62.0 + + p-limit@3.1.0: + dependencies: + yocto-queue: 0.1.0 + + p-locate@5.0.0: + dependencies: + p-limit: 3.1.0 + + parent-module@1.0.1: + dependencies: + callsites: 3.1.0 + + parse-imports-exports@0.2.4: + dependencies: + parse-statements: 1.0.11 + + parse-json@5.2.0: + dependencies: + '@babel/code-frame': 7.29.0 + error-ex: 1.3.4 + json-parse-even-better-errors: 2.3.1 + lines-and-columns: 1.2.4 + + parse-statements@1.0.11: {} + + path-exists@4.0.0: {} + + path-key@3.1.1: {} + + path-parse@1.0.7: {} + + picocolors@1.1.1: {} + + picomatch@2.3.2: {} + + picomatch@4.0.4: {} + + playwright-core@1.59.1: {} + + playwright@1.59.1: + dependencies: + playwright-core: 1.59.1 + + pluralize@8.0.0: {} + + possible-typed-array-names@1.1.0: {} + + postcss-media-query-parser@0.2.3: {} + + postcss-resolve-nested-selector@0.1.6: {} + + postcss-safe-parser@7.0.1(postcss@8.5.12): + dependencies: + postcss: 8.5.12 + + postcss-scss@4.0.9(postcss@8.5.12): + dependencies: + postcss: 8.5.12 + + postcss-selector-parser@7.1.1: + dependencies: + cssesc: 3.0.0 + util-deprecate: 1.0.2 + + postcss-sorting@10.0.0(postcss@8.5.12): + dependencies: + postcss: 8.5.12 + + postcss-value-parser@4.2.0: {} + + postcss@8.5.12: + dependencies: + nanoid: 3.3.11 + picocolors: 1.1.1 + source-map-js: 1.2.1 + + prelude-ls@1.2.1: {} + + prettier-plugin-curly@0.4.1(prettier@3.8.3): + dependencies: + prettier: 3.8.3 + + prettier-plugin-ini@1.3.0: + dependencies: + prettier: 3.8.3 + + prettier-plugin-jsdoc@1.8.0(prettier@3.8.3): + dependencies: + binary-searching: 2.0.5 + comment-parser: 1.4.6 + mdast-util-from-markdown: 2.0.3 + prettier: 3.8.3 + + prettier-plugin-pkg@0.22.1(prettier@3.8.3): + dependencies: + prettier: 3.8.3 + + prettier-plugin-sh@0.18.1(prettier@3.8.3): + dependencies: + '@reteps/dockerfmt': 0.5.2 + prettier: 3.8.3 + sh-syntax: 0.5.8 + + prettier-plugin-sort-json@4.2.0(prettier@3.8.3): + dependencies: + prettier: 3.8.3 + + prettier@3.8.3: {} + + punycode@2.3.1: {} + + pure-rand@8.4.0: {} + + purify-ts@2.1.2: + dependencies: + '@types/json-schema': 7.0.15 + + qified@0.9.1: + dependencies: + hookified: 2.2.0 + + queue-microtask@1.2.3: {} + + refa@0.12.1: + dependencies: + '@eslint-community/regexpp': 4.12.2 + + reflect.getprototypeof@1.0.10: + dependencies: + call-bind: 1.0.9 + define-properties: 1.2.1 + es-abstract: 1.24.2 + es-errors: 1.3.0 + es-object-atoms: 1.1.1 + get-intrinsic: 1.3.1 + get-proto: 1.0.1 + which-builtin-type: 1.2.1 + + regenerate-unicode-properties@10.2.2: + dependencies: + regenerate: 1.4.2 + + regenerate@1.4.2: {} + + regenerator-runtime@0.14.1: {} + + regexp-ast-analysis@0.7.1: + dependencies: + '@eslint-community/regexpp': 4.12.2 + refa: 0.12.1 + + regexp-tree@0.1.27: {} + + regexp.prototype.flags@1.5.4: + dependencies: + call-bind: 1.0.9 + define-properties: 1.2.1 + es-errors: 1.3.0 + get-proto: 1.0.1 + gopd: 1.2.0 + set-function-name: 2.0.2 + + regexpu-core@6.4.0: + dependencies: + regenerate: 1.4.2 + regenerate-unicode-properties: 10.2.2 + regjsgen: 0.8.0 + regjsparser: 0.13.1 + unicode-match-property-ecmascript: 2.0.0 + unicode-match-property-value-ecmascript: 2.2.1 + + regjsgen@0.8.0: {} + + regjsparser@0.13.1: + dependencies: + jsesc: 3.1.0 + + require-from-string@2.0.2: {} + + reserved-identifiers@1.2.0: {} + + resolve-from@4.0.0: {} + + resolve-pkg-maps@1.0.0: {} + + resolve@1.22.12: + dependencies: + es-errors: 1.3.0 + is-core-module: 2.16.1 + path-parse: 1.0.7 + supports-preserve-symlinks-flag: 1.0.0 + + reusify@1.1.0: {} + + rolldown@1.0.0-rc.17: + dependencies: + '@oxc-project/types': 0.127.0 + '@rolldown/pluginutils': 1.0.0-rc.17 + optionalDependencies: + '@rolldown/binding-linux-x64-gnu': 1.0.0-rc.17 + '@rolldown/binding-linux-x64-musl': 1.0.0-rc.17 + + run-parallel@1.2.0: + dependencies: + queue-microtask: 1.2.3 + + rxjs@7.8.2: + dependencies: + tslib: 2.8.1 + + safe-array-concat@1.1.4: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + get-intrinsic: 1.3.1 + has-symbols: 1.1.0 + isarray: 2.0.5 + + safe-push-apply@1.0.0: + dependencies: + es-errors: 1.3.0 + isarray: 2.0.5 + + safe-regex-test@1.1.0: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + is-regex: 1.2.1 + + sass-embedded-linux-musl-x64@1.99.0: {} + + sass-embedded-linux-x64@1.99.0: {} + + sass-embedded@1.99.0: + dependencies: + '@bufbuild/protobuf': 2.12.0 + colorjs.io: 0.5.2 + immutable: 5.1.5 + rxjs: 7.8.2 + supports-color: 8.1.1 + sync-child-process: 1.0.2 + varint: 6.0.0 + optionalDependencies: + sass-embedded-linux-musl-x64: 1.99.0 + sass-embedded-linux-x64: 1.99.0 + + scslre@0.3.0: + dependencies: + '@eslint-community/regexpp': 4.12.2 + refa: 0.12.1 + regexp-ast-analysis: 0.7.1 + + semver@6.3.1: {} + + semver@7.7.4: {} + + set-function-length@1.2.2: + dependencies: + define-data-property: 1.1.4 + es-errors: 1.3.0 + function-bind: 1.1.2 + get-intrinsic: 1.3.1 + gopd: 1.2.0 + has-property-descriptors: 1.0.2 + + set-function-name@2.0.2: + dependencies: + define-data-property: 1.1.4 + es-errors: 1.3.0 + functions-have-names: 1.2.3 + has-property-descriptors: 1.0.2 + + set-proto@1.0.0: + dependencies: + dunder-proto: 1.0.1 + es-errors: 1.3.0 + es-object-atoms: 1.1.1 + + sh-syntax@0.5.8: + dependencies: + tslib: 2.8.1 + + shebang-command@2.0.0: + dependencies: + shebang-regex: 3.0.0 + + shebang-regex@3.0.0: {} + + side-channel-list@1.0.1: + dependencies: + es-errors: 1.3.0 + object-inspect: 1.13.4 + + side-channel-map@1.0.1: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + get-intrinsic: 1.3.1 + object-inspect: 1.13.4 + + side-channel-weakmap@1.0.2: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + get-intrinsic: 1.3.1 + object-inspect: 1.13.4 + side-channel-map: 1.0.1 + + side-channel@1.1.0: + dependencies: + es-errors: 1.3.0 + object-inspect: 1.13.4 + side-channel-list: 1.0.1 + side-channel-map: 1.0.1 + side-channel-weakmap: 1.0.2 + + signal-exit@4.1.0: {} + + slash@5.1.0: {} + + slice-ansi@4.0.0: + dependencies: + ansi-styles: 4.3.0 + astral-regex: 2.0.0 + is-fullwidth-code-point: 3.0.0 + + smol-toml@1.6.1: {} + + source-map-js@1.2.1: {} + + source-map-support@0.5.21: + dependencies: + buffer-from: 1.1.2 + source-map: 0.6.1 + + source-map@0.6.1: {} + + spdx-exceptions@2.5.0: {} + + spdx-expression-parse@4.0.0: + dependencies: + spdx-exceptions: 2.5.0 + spdx-license-ids: 3.0.23 + + spdx-license-ids@3.0.23: {} + + stop-iteration-iterator@1.1.0: + dependencies: + es-errors: 1.3.0 + internal-slot: 1.1.0 + + string-width@4.2.3: + dependencies: + emoji-regex: 8.0.0 + is-fullwidth-code-point: 3.0.0 + strip-ansi: 6.0.1 + + string-width@8.2.1: + dependencies: + get-east-asian-width: 1.5.0 + strip-ansi: 7.2.0 + + string.prototype.includes@2.0.1: + dependencies: + call-bind: 1.0.9 + define-properties: 1.2.1 + es-abstract: 1.24.2 + + string.prototype.trim@1.2.10: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + define-data-property: 1.1.4 + define-properties: 1.2.1 + es-abstract: 1.24.2 + es-object-atoms: 1.1.1 + has-property-descriptors: 1.0.2 + + string.prototype.trimend@1.0.9: + dependencies: + call-bind: 1.0.9 + call-bound: 1.0.4 + define-properties: 1.2.1 + es-object-atoms: 1.1.1 + + string.prototype.trimstart@1.0.8: + dependencies: + call-bind: 1.0.9 + define-properties: 1.2.1 + es-object-atoms: 1.1.1 + + strip-ansi@6.0.1: + dependencies: + ansi-regex: 5.0.1 + + strip-ansi@7.2.0: + dependencies: + ansi-regex: 6.2.2 + + strip-indent@4.1.1: {} + + strip-json-comments@5.0.3: {} + + style-search@0.1.0: {} + + stylelint-config-clean-order@8.0.1(stylelint@17.9.1)(stylelint-order@8.1.1(stylelint@17.9.1)): + dependencies: + stylelint: 17.9.1 + stylelint-order: 8.1.1(stylelint@17.9.1) + + stylelint-config-recommended-scss@17.0.1(postcss@8.5.12)(stylelint@17.9.1): + dependencies: + postcss: 8.5.12 + postcss-scss: 4.0.9(postcss@8.5.12) + stylelint: 17.9.1 + stylelint-config-recommended: 18.0.0(stylelint@17.9.1) + stylelint-scss: 7.0.0(stylelint@17.9.1) + + stylelint-config-recommended@18.0.0(stylelint@17.9.1): + dependencies: + stylelint: 17.9.1 + + stylelint-config-sass-guidelines@13.0.0(postcss@8.5.12)(stylelint@17.9.1): + dependencies: + '@stylistic/stylelint-plugin': 5.1.0(stylelint@17.9.1) + postcss: 8.5.12 + postcss-scss: 4.0.9(postcss@8.5.12) + stylelint: 17.9.1 + stylelint-scss: 7.0.0(stylelint@17.9.1) + + stylelint-config-standard-scss@17.0.0(postcss@8.5.12)(stylelint@17.9.1): + dependencies: + postcss: 8.5.12 + stylelint: 17.9.1 + stylelint-config-recommended-scss: 17.0.1(postcss@8.5.12)(stylelint@17.9.1) + stylelint-config-standard: 40.0.0(stylelint@17.9.1) + + stylelint-config-standard@40.0.0(stylelint@17.9.1): + dependencies: + stylelint: 17.9.1 + stylelint-config-recommended: 18.0.0(stylelint@17.9.1) + + stylelint-declaration-block-no-ignored-properties@3.0.0(stylelint@17.9.1): + dependencies: + stylelint: 17.9.1 + + stylelint-order@8.1.1(stylelint@17.9.1): + dependencies: + postcss: 8.5.12 + postcss-sorting: 10.0.0(postcss@8.5.12) + stylelint: 17.9.1 + + stylelint-plugin-logical-css@2.1.0(stylelint@17.9.1): + dependencies: + stylelint: 17.9.1 + + stylelint-scss@7.0.0(stylelint@17.9.1): + dependencies: + css-tree: 3.2.1 + is-plain-object: 5.0.0 + known-css-properties: 0.37.0 + mdn-data: 2.27.1 + postcss-media-query-parser: 0.2.3 + postcss-resolve-nested-selector: 0.1.6 + postcss-selector-parser: 7.1.1 + postcss-value-parser: 4.2.0 + stylelint: 17.9.1 + + stylelint@17.9.1: + dependencies: + '@csstools/css-calc': 3.2.0(@csstools/css-parser-algorithms@4.0.0(@csstools/css-tokenizer@4.0.0))(@csstools/css-tokenizer@4.0.0) + '@csstools/css-parser-algorithms': 4.0.0(@csstools/css-tokenizer@4.0.0) + '@csstools/css-syntax-patches-for-csstree': 1.1.3(css-tree@3.2.1) + '@csstools/css-tokenizer': 4.0.0 + '@csstools/media-query-list-parser': 5.0.0(@csstools/css-parser-algorithms@4.0.0(@csstools/css-tokenizer@4.0.0))(@csstools/css-tokenizer@4.0.0) + '@csstools/selector-resolve-nested': 4.0.0(postcss-selector-parser@7.1.1) + '@csstools/selector-specificity': 6.0.0(postcss-selector-parser@7.1.1) + colord: 2.9.3 + cosmiconfig: 9.0.1(typescript@6.0.3) + css-functions-list: 3.3.3 + css-tree: 3.2.1 + debug: 4.4.3 + fast-glob: 3.3.3 + fastest-levenshtein: 1.0.16 + file-entry-cache: 11.1.2 + global-modules: 2.0.0 + globby: 16.2.0 + globjoin: 0.1.4 + html-tags: 5.1.0 + ignore: 7.0.5 + import-meta-resolve: 4.2.0 + is-plain-object: 5.0.0 + mathml-tag-names: 4.0.0 + meow: 14.1.0 + micromatch: 4.0.8 + normalize-path: 3.0.0 + picocolors: 1.1.1 + postcss: 8.5.12 + postcss-safe-parser: 7.0.1(postcss@8.5.12) + postcss-selector-parser: 7.1.1 + postcss-value-parser: 4.2.0 + string-width: 8.2.1 + supports-hyperlinks: 4.4.0 + svg-tags: 1.0.0 + table: 6.9.0 + write-file-atomic: 7.0.1 + + supports-color@10.2.2: {} + + supports-color@8.1.1: + dependencies: + has-flag: 4.0.0 + + supports-hyperlinks@4.4.0: + dependencies: + has-flag: 5.0.1 + supports-color: 10.2.2 + + supports-preserve-symlinks-flag@1.0.0: {} + + svg-tags@1.0.0: {} + + sync-child-process@1.0.2: + dependencies: + sync-message-port: 1.2.0 + + sync-message-port@1.2.0: {} + + synckit@0.11.12: + dependencies: + '@pkgr/core': 0.2.9 + + systemjs@6.15.1: {} + + table@6.9.0: + dependencies: + ajv: 8.20.0 + lodash.truncate: 4.4.2 + slice-ansi: 4.0.0 + string-width: 4.2.3 + strip-ansi: 6.0.1 + + terser@5.46.2: + dependencies: + '@jridgewell/source-map': 0.3.11 + acorn: 8.16.0 + commander: 2.20.3 + source-map-support: 0.5.21 + + tinyglobby@0.2.16: + dependencies: + fdir: 6.5.0(picomatch@4.0.4) + picomatch: 4.0.4 + + to-regex-range@5.0.1: + dependencies: + is-number: 7.0.0 + + to-valid-identifier@1.0.0: + dependencies: + '@sindresorhus/base62': 1.0.0 + reserved-identifiers: 1.2.0 + + toml@4.1.1: {} + + ts-api-utils@2.5.0(typescript@6.0.3): + dependencies: + typescript: 6.0.3 + + ts-declaration-location@1.0.7(typescript@6.0.3): + dependencies: + picomatch: 4.0.4 + typescript: 6.0.3 + + ts-pattern@5.9.0: {} + + tsconfck@3.1.6(typescript@6.0.3): + dependencies: + typescript: 6.0.3 + + tslib@2.8.1: {} + + type-check@0.4.0: + dependencies: + prelude-ls: 1.2.1 + + typed-array-buffer@1.0.3: + dependencies: + call-bound: 1.0.4 + es-errors: 1.3.0 + is-typed-array: 1.1.15 + + typed-array-byte-length@1.0.3: + dependencies: + call-bind: 1.0.9 + for-each: 0.3.5 + gopd: 1.2.0 + has-proto: 1.2.0 + is-typed-array: 1.1.15 + + typed-array-byte-offset@1.0.4: + dependencies: + available-typed-arrays: 1.0.7 + call-bind: 1.0.9 + for-each: 0.3.5 + gopd: 1.2.0 + has-proto: 1.2.0 + is-typed-array: 1.1.15 + reflect.getprototypeof: 1.0.10 + + typed-array-length@1.0.7: + dependencies: + call-bind: 1.0.9 + for-each: 0.3.5 + gopd: 1.2.0 + is-typed-array: 1.1.15 + possible-typed-array-names: 1.1.0 + reflect.getprototypeof: 1.0.10 + + typescript-eslint@8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3): + dependencies: + '@typescript-eslint/eslint-plugin': 8.59.1(@typescript-eslint/parser@8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3))(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + '@typescript-eslint/parser': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + '@typescript-eslint/typescript-estree': 8.59.1(typescript@6.0.3) + '@typescript-eslint/utils': 8.59.1(eslint@10.3.0(jiti@2.6.1))(typescript@6.0.3) + eslint: 10.3.0(jiti@2.6.1) + typescript: 6.0.3 + + typescript@6.0.3: {} + + unbash@3.0.0: {} + + unbox-primitive@1.1.0: + dependencies: + call-bound: 1.0.4 + has-bigints: 1.1.0 + has-symbols: 1.1.0 + which-boxed-primitive: 1.1.1 + + undici-types@7.19.2: {} + + unicode-canonical-property-names-ecmascript@2.0.1: {} + + unicode-match-property-ecmascript@2.0.0: + dependencies: + unicode-canonical-property-names-ecmascript: 2.0.1 + unicode-property-aliases-ecmascript: 2.2.0 + + unicode-match-property-value-ecmascript@2.2.1: {} + + unicode-property-aliases-ecmascript@2.2.0: {} + + unicorn-magic@0.4.0: {} + + unist-util-stringify-position@4.0.0: + dependencies: + '@types/unist': 3.0.3 + + update-browserslist-db@1.2.3(browserslist@4.28.2): + dependencies: + browserslist: 4.28.2 + escalade: 3.2.0 + picocolors: 1.1.1 + + uri-js@4.4.1: + dependencies: + punycode: 2.3.1 + + util-deprecate@1.0.2: {} + + uuid@13.0.0: {} + + valibot@1.1.0(typescript@6.0.3): + dependencies: + typescript: 6.0.3 + + varint@6.0.0: {} + + vite-tsconfig-paths@6.1.1(vite@8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3)): + dependencies: + debug: 4.4.3 + globrex: 0.1.2 + tsconfck: 3.1.6(typescript@6.0.3) + vite: 8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3) + + vite@8.0.10(@types/node@25.6.0)(jiti@2.6.1)(sass-embedded@1.99.0)(terser@5.46.2)(yaml@2.8.3): + dependencies: + '@types/node': 25.6.0 + jiti: 2.6.1 + lightningcss: 1.32.0 + picomatch: 4.0.4 + postcss: 8.5.12 + rolldown: 1.0.0-rc.17 + sass-embedded: 1.99.0 + terser: 5.46.2 + tinyglobby: 0.2.16 + yaml: 2.8.3 + + walk-up-path@4.0.0: {} + + which-boxed-primitive@1.1.1: + dependencies: + is-bigint: 1.1.0 + is-boolean-object: 1.2.2 + is-number-object: 1.1.1 + is-string: 1.1.1 + is-symbol: 1.1.1 + + which-builtin-type@1.2.1: + dependencies: + call-bound: 1.0.4 + function.prototype.name: 1.1.8 + has-tostringtag: 1.0.2 + is-async-function: 2.1.1 + is-date-object: 1.1.0 + is-finalizationregistry: 1.1.1 + is-generator-function: 1.1.2 + is-regex: 1.2.1 + is-weakref: 1.1.1 + isarray: 2.0.5 + which-boxed-primitive: 1.1.1 + which-collection: 1.0.2 + which-typed-array: 1.1.20 + + which-collection@1.0.2: + dependencies: + is-map: 2.0.3 + is-set: 2.0.3 + is-weakmap: 2.0.2 + is-weakset: 2.0.4 + + which-typed-array@1.1.20: + dependencies: + available-typed-arrays: 1.0.7 + call-bind: 1.0.9 + call-bound: 1.0.4 + for-each: 0.3.5 + get-proto: 1.0.1 + gopd: 1.2.0 + has-tostringtag: 1.0.2 + + which@1.3.1: + dependencies: + isexe: 2.0.0 + + which@2.0.2: + dependencies: + isexe: 2.0.0 + + word-wrap@1.2.5: {} + + write-file-atomic@7.0.1: + dependencies: + signal-exit: 4.1.0 + + yallist@3.1.1: {} + + yaml@2.8.3: {} + + yocto-queue@0.1.0: {} + + zod@4.3.6: {} diff --git a/aube-workspace.yaml b/aube-workspace.yaml new file mode 100644 index 00000000..d66ac122 --- /dev/null +++ b/aube-workspace.yaml @@ -0,0 +1,6 @@ +jailBuilds: false +nodeLinker: isolated +packageManagerStrict: true +packageManagerStrictVersion: true +trustPolicy: off +useBetaCli: true diff --git a/biome.json b/biome.json deleted file mode 100755 index a8aae965..00000000 --- a/biome.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "$schema": "https://biomejs.dev/schemas/2.0.4/schema.json", - "assist": { "enabled": false }, - "css": { "formatter": { "enabled": false }, "linter": { "enabled": true } }, - "files": { - "experimentalScannerIgnores": [ - "*.min.js", - "vendor", - "web/app/plugins", - "web/app/themes/haiku-atelier-2024/assets", - "web/wp" - ], - "ignoreUnknown": true, - "maxSize": 100000000 - }, - "formatter": { "enabled": false }, - "graphql": { "formatter": { "enabled": false }, "linter": { "enabled": true } }, - "json": { "formatter": { "enabled": false }, "linter": { "enabled": true } }, - "linter": { - "enabled": false, - "rules": { - "complexity": { "noForEach": "off" }, - "nursery": { - "recommended": true, - "useSortedClasses": { - "fix": "unsafe", - "level": "error", - "options": { "attributes": ["class"], "functions": [""] } - } - }, - "recommended": true, - "style": { - "noInferrableTypes": "error", - "noNonNullAssertion": "off", - "noParameterAssign": "error", - "noUnusedTemplateLiteral": "error", - "noUselessElse": "error", - "recommended": true, - "useAsConstAssertion": "error", - "useDefaultParameterLast": "error", - "useEnumInitializers": "error", - "useNumberNamespace": "error", - "useSelfClosingElements": "error", - "useSingleVarDeclarator": "error" - } - } - } -} diff --git a/bun.lock b/bun.lock deleted file mode 100644 index 7feda8ed..00000000 --- a/bun.lock +++ /dev/null @@ -1,1593 +0,0 @@ -{ - "lockfileVersion": 1, - "configVersion": 1, - "workspaces": { - "": { - "name": "haikuatelier.fr", - "dependencies": { - "@effect/language-service": "^0.60.0", - "@logtape/logtape": "^1.2.2", - "@mobily/ts-belt": "v4.0.0-rc.5", - "@sentry/browser": "^10.29.0", - "a11y-dialog": "^8.1.4", - "chalk": "^5.6.2", - "effect": "^3.19.9", - "lit-html": "^3.3.1", - "loglevel": "^1.9.2", - "loglevel-plugin-prefix": "^0.8.4", - "optics-ts": "^2.4.1", - "purify-ts": "2.1.2", - "ts-pattern": "^5.9.0", - "valibot": "1.1.0", - }, - "devDependencies": { - "@biomejs/biome": "^2.3.8", - "@cspell/dict-fr-fr": "^2.3.2", - "@eslint/js": "^9.39.1", - "@playwright/test": "^1.57.0", - "@prettier/plugin-xml": "^3.4.2", - "@sentry/core": "^10.29.0", - "@swc/cli": "0.7.8", - "@types/eslint__js": "^9.14.0", - "@types/node": "^24.10.1", - "@vitejs/plugin-legacy": "^7.2.1", - "better-typescript-lib": "^2.12.0", - "browserslist": "^4.28.1", - "caniuse-lite": "^1.0.30001759", - "eslint": "^9.39.1", - "eslint-plugin-oxlint": "^1.31.0", - "eslint-plugin-perfectionist": "^4.15.1", - "fdir": "^6.5.0", - "globals": "^16.5.0", - "knip": "^5.71.0", - "lightningcss-cli": "^1.30.2", - "oxlint": "^1.31.0", - "picomatch": "^4.0.3", - "playwright": "^1.57.0", - "prettier": "^4.0.0-alpha.13", - "prettier-plugin-pkg": "^0.21.2", - "prettier-plugin-sh": "^0.18.0", - "sass-embedded": "^1.93.3", - "stylelint": "^16.26.1", - "stylelint-config-clean-order": "^8.0.0", - "stylelint-config-sass-guidelines": "^12.1.0", - "stylelint-config-standard-scss": "^16.0.0", - "stylelint-declaration-block-no-ignored-properties": "^2.8.0", - "stylelint-plugin-logical-css": "^1.2.3", - "typescript": "5.9.3", - "typescript-eslint": "^8.48.1", - "vite": "^7.2.6", - "vite-plugin-valibot-env": "^1.0.1", - "vite-tsconfig-paths": "^5.1.4", - "wp-types": "^4.69.0", - }, - }, - }, - "trustedDependencies": [ - "lightningcss-cli", - "core-js", - "esbuild", - "@biomejs/biome", - "@swc/core", - "@parcel/watcher", - ], - "packages": { - "@babel/code-frame": ["@babel/code-frame@7.29.0", "", { "dependencies": { "@babel/helper-validator-identifier": "^7.28.5", "js-tokens": "^4.0.0", "picocolors": "^1.1.1" } }, "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw=="], - - "@babel/compat-data": ["@babel/compat-data@7.29.0", "", {}, "sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg=="], - - "@babel/core": ["@babel/core@7.29.0", "", { "dependencies": { "@babel/code-frame": "^7.29.0", "@babel/generator": "^7.29.0", "@babel/helper-compilation-targets": "^7.28.6", "@babel/helper-module-transforms": "^7.28.6", "@babel/helpers": "^7.28.6", "@babel/parser": "^7.29.0", "@babel/template": "^7.28.6", "@babel/traverse": "^7.29.0", "@babel/types": "^7.29.0", "@jridgewell/remapping": "^2.3.5", "convert-source-map": "^2.0.0", "debug": "^4.1.0", "gensync": "^1.0.0-beta.2", "json5": "^2.2.3", "semver": "^6.3.1" } }, "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA=="], - - "@babel/generator": ["@babel/generator@7.29.1", "", { "dependencies": { "@babel/parser": "^7.29.0", "@babel/types": "^7.29.0", "@jridgewell/gen-mapping": "^0.3.12", "@jridgewell/trace-mapping": "^0.3.28", "jsesc": "^3.0.2" } }, "sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw=="], - - "@babel/helper-annotate-as-pure": ["@babel/helper-annotate-as-pure@7.27.3", "", { "dependencies": { "@babel/types": "^7.27.3" } }, "sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg=="], - - "@babel/helper-compilation-targets": ["@babel/helper-compilation-targets@7.28.6", "", { "dependencies": { "@babel/compat-data": "^7.28.6", "@babel/helper-validator-option": "^7.27.1", "browserslist": "^4.24.0", "lru-cache": "^5.1.1", "semver": "^6.3.1" } }, "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA=="], - - "@babel/helper-create-class-features-plugin": ["@babel/helper-create-class-features-plugin@7.28.6", "", { "dependencies": { "@babel/helper-annotate-as-pure": "^7.27.3", "@babel/helper-member-expression-to-functions": "^7.28.5", "@babel/helper-optimise-call-expression": "^7.27.1", "@babel/helper-replace-supers": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", "@babel/traverse": "^7.28.6", "semver": "^6.3.1" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-dTOdvsjnG3xNT9Y0AUg1wAl38y+4Rl4sf9caSQZOXdNqVn+H+HbbJ4IyyHaIqNR6SW9oJpA/RuRjsjCw2IdIow=="], - - "@babel/helper-create-regexp-features-plugin": ["@babel/helper-create-regexp-features-plugin@7.28.5", "", { "dependencies": { "@babel/helper-annotate-as-pure": "^7.27.3", "regexpu-core": "^6.3.1", "semver": "^6.3.1" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw=="], - - "@babel/helper-define-polyfill-provider": ["@babel/helper-define-polyfill-provider@0.6.8", "", { "dependencies": { "@babel/helper-compilation-targets": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6", "debug": "^4.4.3", "lodash.debounce": "^4.0.8", "resolve": "^1.22.11" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "sha512-47UwBLPpQi1NoWzLuHNjRoHlYXMwIJoBf7MFou6viC/sIHWYygpvr0B6IAyh5sBdA2nr2LPIRww8lfaUVQINBA=="], - - "@babel/helper-globals": ["@babel/helper-globals@7.28.0", "", {}, "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw=="], - - "@babel/helper-member-expression-to-functions": ["@babel/helper-member-expression-to-functions@7.28.5", "", { "dependencies": { "@babel/traverse": "^7.28.5", "@babel/types": "^7.28.5" } }, "sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg=="], - - "@babel/helper-module-imports": ["@babel/helper-module-imports@7.28.6", "", { "dependencies": { "@babel/traverse": "^7.28.6", "@babel/types": "^7.28.6" } }, "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw=="], - - "@babel/helper-module-transforms": ["@babel/helper-module-transforms@7.28.6", "", { "dependencies": { "@babel/helper-module-imports": "^7.28.6", "@babel/helper-validator-identifier": "^7.28.5", "@babel/traverse": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA=="], - - "@babel/helper-optimise-call-expression": ["@babel/helper-optimise-call-expression@7.27.1", "", { "dependencies": { "@babel/types": "^7.27.1" } }, "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw=="], - - "@babel/helper-plugin-utils": ["@babel/helper-plugin-utils@7.28.6", "", {}, "sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug=="], - - "@babel/helper-remap-async-to-generator": ["@babel/helper-remap-async-to-generator@7.27.1", "", { "dependencies": { "@babel/helper-annotate-as-pure": "^7.27.1", "@babel/helper-wrap-function": "^7.27.1", "@babel/traverse": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA=="], - - "@babel/helper-replace-supers": ["@babel/helper-replace-supers@7.28.6", "", { "dependencies": { "@babel/helper-member-expression-to-functions": "^7.28.5", "@babel/helper-optimise-call-expression": "^7.27.1", "@babel/traverse": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-mq8e+laIk94/yFec3DxSjCRD2Z0TAjhVbEJY3UQrlwVo15Lmt7C2wAUbK4bjnTs4APkwsYLTahXRraQXhb1WCg=="], - - "@babel/helper-skip-transparent-expression-wrappers": ["@babel/helper-skip-transparent-expression-wrappers@7.27.1", "", { "dependencies": { "@babel/traverse": "^7.27.1", "@babel/types": "^7.27.1" } }, "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg=="], - - "@babel/helper-string-parser": ["@babel/helper-string-parser@7.27.1", "", {}, "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA=="], - - "@babel/helper-validator-identifier": ["@babel/helper-validator-identifier@7.28.5", "", {}, "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q=="], - - "@babel/helper-validator-option": ["@babel/helper-validator-option@7.27.1", "", {}, "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg=="], - - "@babel/helper-wrap-function": ["@babel/helper-wrap-function@7.28.6", "", { "dependencies": { "@babel/template": "^7.28.6", "@babel/traverse": "^7.28.6", "@babel/types": "^7.28.6" } }, "sha512-z+PwLziMNBeSQJonizz2AGnndLsP2DeGHIxDAn+wdHOGuo4Fo1x1HBPPXeE9TAOPHNNWQKCSlA2VZyYyyibDnQ=="], - - "@babel/helpers": ["@babel/helpers@7.29.2", "", { "dependencies": { "@babel/template": "^7.28.6", "@babel/types": "^7.29.0" } }, "sha512-HoGuUs4sCZNezVEKdVcwqmZN8GoHirLUcLaYVNBK2J0DadGtdcqgr3BCbvH8+XUo4NGjNl3VOtSjEKNzqfFgKw=="], - - "@babel/parser": ["@babel/parser@7.29.2", "", { "dependencies": { "@babel/types": "^7.29.0" }, "bin": "./bin/babel-parser.js" }, "sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA=="], - - "@babel/plugin-bugfix-firefox-class-in-computed-class-key": ["@babel/plugin-bugfix-firefox-class-in-computed-class-key@7.28.5", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/traverse": "^7.28.5" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q=="], - - "@babel/plugin-bugfix-safari-class-field-initializer-scope": ["@babel/plugin-bugfix-safari-class-field-initializer-scope@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA=="], - - "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": ["@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA=="], - - "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": ["@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", "@babel/plugin-transform-optional-chaining": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.13.0" } }, "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw=="], - - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": ["@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6", "@babel/traverse": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-a0aBScVTlNaiUe35UtfxAN7A/tehvvG4/ByO6+46VPKTRSlfnAFsgKy0FUh+qAkQrDTmhDkT+IBOKlOoMUxQ0g=="], - - "@babel/plugin-proposal-private-property-in-object": ["@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2", "", { "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w=="], - - "@babel/plugin-syntax-import-assertions": ["@babel/plugin-syntax-import-assertions@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-pSJUpFHdx9z5nqTSirOCMtYVP2wFgoWhP0p3g8ONK/4IHhLIBd0B9NYqAvIUAhq+OkhO4VM1tENCt0cjlsNShw=="], - - "@babel/plugin-syntax-import-attributes": ["@babel/plugin-syntax-import-attributes@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw=="], - - "@babel/plugin-syntax-unicode-sets-regex": ["@babel/plugin-syntax-unicode-sets-regex@7.18.6", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.18.6", "@babel/helper-plugin-utils": "^7.18.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg=="], - - "@babel/plugin-transform-arrow-functions": ["@babel/plugin-transform-arrow-functions@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA=="], - - "@babel/plugin-transform-async-generator-functions": ["@babel/plugin-transform-async-generator-functions@7.29.0", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-remap-async-to-generator": "^7.27.1", "@babel/traverse": "^7.29.0" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w=="], - - "@babel/plugin-transform-async-to-generator": ["@babel/plugin-transform-async-to-generator@7.28.6", "", { "dependencies": { "@babel/helper-module-imports": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-remap-async-to-generator": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-ilTRcmbuXjsMmcZ3HASTe4caH5Tpo93PkTxF9oG2VZsSWsahydmcEHhix9Ik122RcTnZnUzPbmux4wh1swfv7g=="], - - "@babel/plugin-transform-block-scoped-functions": ["@babel/plugin-transform-block-scoped-functions@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg=="], - - "@babel/plugin-transform-block-scoping": ["@babel/plugin-transform-block-scoping@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-tt/7wOtBmwHPNMPu7ax4pdPz6shjFrmHDghvNC+FG9Qvj7D6mJcoRQIF5dy4njmxR941l6rgtvfSB2zX3VlUIw=="], - - "@babel/plugin-transform-class-properties": ["@babel/plugin-transform-class-properties@7.28.6", "", { "dependencies": { "@babel/helper-create-class-features-plugin": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-dY2wS3I2G7D697VHndN91TJr8/AAfXQNt5ynCTI/MpxMsSzHp+52uNivYT5wCPax3whc47DR8Ba7cmlQMg24bw=="], - - "@babel/plugin-transform-class-static-block": ["@babel/plugin-transform-class-static-block@7.28.6", "", { "dependencies": { "@babel/helper-create-class-features-plugin": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.12.0" } }, "sha512-rfQ++ghVwTWTqQ7w8qyDxL1XGihjBss4CmTgGRCTAC9RIbhVpyp4fOeZtta0Lbf+dTNIVJer6ych2ibHwkZqsQ=="], - - "@babel/plugin-transform-classes": ["@babel/plugin-transform-classes@7.28.6", "", { "dependencies": { "@babel/helper-annotate-as-pure": "^7.27.3", "@babel/helper-compilation-targets": "^7.28.6", "@babel/helper-globals": "^7.28.0", "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-replace-supers": "^7.28.6", "@babel/traverse": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-EF5KONAqC5zAqT783iMGuM2ZtmEBy+mJMOKl2BCvPZ2lVrwvXnB6o+OBWCS+CoeCCpVRF2sA2RBKUxvT8tQT5Q=="], - - "@babel/plugin-transform-computed-properties": ["@babel/plugin-transform-computed-properties@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6", "@babel/template": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-bcc3k0ijhHbc2lEfpFHgx7eYw9KNXqOerKWfzbxEHUGKnS3sz9C4CNL9OiFN1297bDNfUiSO7DaLzbvHQQQ1BQ=="], - - "@babel/plugin-transform-destructuring": ["@babel/plugin-transform-destructuring@7.28.5", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/traverse": "^7.28.5" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw=="], - - "@babel/plugin-transform-dotall-regex": ["@babel/plugin-transform-dotall-regex@7.28.6", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.28.5", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-SljjowuNKB7q5Oayv4FoPzeB74g3QgLt8IVJw9ADvWy3QnUb/01aw8I4AVv8wYnPvQz2GDDZ/g3GhcNyDBI4Bg=="], - - "@babel/plugin-transform-duplicate-keys": ["@babel/plugin-transform-duplicate-keys@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q=="], - - "@babel/plugin-transform-duplicate-named-capturing-groups-regex": ["@babel/plugin-transform-duplicate-named-capturing-groups-regex@7.29.0", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.28.5", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw=="], - - "@babel/plugin-transform-dynamic-import": ["@babel/plugin-transform-dynamic-import@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A=="], - - "@babel/plugin-transform-explicit-resource-management": ["@babel/plugin-transform-explicit-resource-management@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6", "@babel/plugin-transform-destructuring": "^7.28.5" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-Iao5Konzx2b6g7EPqTy40UZbcdXE126tTxVFr/nAIj+WItNxjKSYTEw3RC+A2/ZetmdJsgueL1KhaMCQHkLPIg=="], - - "@babel/plugin-transform-exponentiation-operator": ["@babel/plugin-transform-exponentiation-operator@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-WitabqiGjV/vJ0aPOLSFfNY1u9U3R7W36B03r5I2KoNix+a3sOhJ3pKFB3R5It9/UiK78NiO0KE9P21cMhlPkw=="], - - "@babel/plugin-transform-export-namespace-from": ["@babel/plugin-transform-export-namespace-from@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ=="], - - "@babel/plugin-transform-for-of": ["@babel/plugin-transform-for-of@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw=="], - - "@babel/plugin-transform-function-name": ["@babel/plugin-transform-function-name@7.27.1", "", { "dependencies": { "@babel/helper-compilation-targets": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1", "@babel/traverse": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ=="], - - "@babel/plugin-transform-json-strings": ["@babel/plugin-transform-json-strings@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-Nr+hEN+0geQkzhbdgQVPoqr47lZbm+5fCUmO70722xJZd0Mvb59+33QLImGj6F+DkK3xgDi1YVysP8whD6FQAw=="], - - "@babel/plugin-transform-literals": ["@babel/plugin-transform-literals@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA=="], - - "@babel/plugin-transform-logical-assignment-operators": ["@babel/plugin-transform-logical-assignment-operators@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-+anKKair6gpi8VsM/95kmomGNMD0eLz1NQ8+Pfw5sAwWH9fGYXT50E55ZpV0pHUHWf6IUTWPM+f/7AAff+wr9A=="], - - "@babel/plugin-transform-member-expression-literals": ["@babel/plugin-transform-member-expression-literals@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ=="], - - "@babel/plugin-transform-modules-amd": ["@babel/plugin-transform-modules-amd@7.27.1", "", { "dependencies": { "@babel/helper-module-transforms": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA=="], - - "@babel/plugin-transform-modules-commonjs": ["@babel/plugin-transform-modules-commonjs@7.28.6", "", { "dependencies": { "@babel/helper-module-transforms": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-jppVbf8IV9iWWwWTQIxJMAJCWBuuKx71475wHwYytrRGQ2CWiDvYlADQno3tcYpS/T2UUWFQp3nVtYfK/YBQrA=="], - - "@babel/plugin-transform-modules-systemjs": ["@babel/plugin-transform-modules-systemjs@7.29.0", "", { "dependencies": { "@babel/helper-module-transforms": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-validator-identifier": "^7.28.5", "@babel/traverse": "^7.29.0" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ=="], - - "@babel/plugin-transform-modules-umd": ["@babel/plugin-transform-modules-umd@7.27.1", "", { "dependencies": { "@babel/helper-module-transforms": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w=="], - - "@babel/plugin-transform-named-capturing-groups-regex": ["@babel/plugin-transform-named-capturing-groups-regex@7.29.0", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.28.5", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ=="], - - "@babel/plugin-transform-new-target": ["@babel/plugin-transform-new-target@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ=="], - - "@babel/plugin-transform-nullish-coalescing-operator": ["@babel/plugin-transform-nullish-coalescing-operator@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-3wKbRgmzYbw24mDJXT7N+ADXw8BC/imU9yo9c9X9NKaLF1fW+e5H1U5QjMUBe4Qo4Ox/o++IyUkl1sVCLgevKg=="], - - "@babel/plugin-transform-numeric-separator": ["@babel/plugin-transform-numeric-separator@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-SJR8hPynj8outz+SlStQSwvziMN4+Bq99it4tMIf5/Caq+3iOc0JtKyse8puvyXkk3eFRIA5ID/XfunGgO5i6w=="], - - "@babel/plugin-transform-object-rest-spread": ["@babel/plugin-transform-object-rest-spread@7.28.6", "", { "dependencies": { "@babel/helper-compilation-targets": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6", "@babel/plugin-transform-destructuring": "^7.28.5", "@babel/plugin-transform-parameters": "^7.27.7", "@babel/traverse": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-5rh+JR4JBC4pGkXLAcYdLHZjXudVxWMXbB6u6+E9lRL5TrGVbHt1TjxGbZ8CkmYw9zjkB7jutzOROArsqtncEA=="], - - "@babel/plugin-transform-object-super": ["@babel/plugin-transform-object-super@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-replace-supers": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng=="], - - "@babel/plugin-transform-optional-catch-binding": ["@babel/plugin-transform-optional-catch-binding@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-R8ja/Pyrv0OGAvAXQhSTmWyPJPml+0TMqXlO5w+AsMEiwb2fg3WkOvob7UxFSL3OIttFSGSRFKQsOhJ/X6HQdQ=="], - - "@babel/plugin-transform-optional-chaining": ["@babel/plugin-transform-optional-chaining@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-A4zobikRGJTsX9uqVFdafzGkqD30t26ck2LmOzAuLL8b2x6k3TIqRiT2xVvA9fNmFeTX484VpsdgmKNA0bS23w=="], - - "@babel/plugin-transform-parameters": ["@babel/plugin-transform-parameters@7.27.7", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg=="], - - "@babel/plugin-transform-private-methods": ["@babel/plugin-transform-private-methods@7.28.6", "", { "dependencies": { "@babel/helper-create-class-features-plugin": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-piiuapX9CRv7+0st8lmuUlRSmX6mBcVeNQ1b4AYzJxfCMuBfB0vBXDiGSmm03pKJw1v6cZ8KSeM+oUnM6yAExg=="], - - "@babel/plugin-transform-private-property-in-object": ["@babel/plugin-transform-private-property-in-object@7.28.6", "", { "dependencies": { "@babel/helper-annotate-as-pure": "^7.27.3", "@babel/helper-create-class-features-plugin": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-b97jvNSOb5+ehyQmBpmhOCiUC5oVK4PMnpRvO7+ymFBoqYjeDHIU9jnrNUuwHOiL9RpGDoKBpSViarV+BU+eVA=="], - - "@babel/plugin-transform-property-literals": ["@babel/plugin-transform-property-literals@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ=="], - - "@babel/plugin-transform-regenerator": ["@babel/plugin-transform-regenerator@7.29.0", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog=="], - - "@babel/plugin-transform-regexp-modifiers": ["@babel/plugin-transform-regexp-modifiers@7.28.6", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.28.5", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-QGWAepm9qxpaIs7UM9FvUSnCGlb8Ua1RhyM4/veAxLwt3gMat/LSGrZixyuj4I6+Kn9iwvqCyPTtbdxanYoWYg=="], - - "@babel/plugin-transform-reserved-words": ["@babel/plugin-transform-reserved-words@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw=="], - - "@babel/plugin-transform-shorthand-properties": ["@babel/plugin-transform-shorthand-properties@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ=="], - - "@babel/plugin-transform-spread": ["@babel/plugin-transform-spread@7.28.6", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-9U4QObUC0FtJl05AsUcodau/RWDytrU6uKgkxu09mLR9HLDAtUMoPuuskm5huQsoktmsYpI+bGmq+iapDcriKA=="], - - "@babel/plugin-transform-sticky-regex": ["@babel/plugin-transform-sticky-regex@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g=="], - - "@babel/plugin-transform-template-literals": ["@babel/plugin-transform-template-literals@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg=="], - - "@babel/plugin-transform-typeof-symbol": ["@babel/plugin-transform-typeof-symbol@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw=="], - - "@babel/plugin-transform-unicode-escapes": ["@babel/plugin-transform-unicode-escapes@7.27.1", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg=="], - - "@babel/plugin-transform-unicode-property-regex": ["@babel/plugin-transform-unicode-property-regex@7.28.6", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.28.5", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-4Wlbdl/sIZjzi/8St0evF0gEZrgOswVO6aOzqxh1kDZOl9WmLrHq2HtGhnOJZmHZYKP8WZ1MDLCt5DAWwRo57A=="], - - "@babel/plugin-transform-unicode-regex": ["@babel/plugin-transform-unicode-regex@7.27.1", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw=="], - - "@babel/plugin-transform-unicode-sets-regex": ["@babel/plugin-transform-unicode-sets-regex@7.28.6", "", { "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.28.5", "@babel/helper-plugin-utils": "^7.28.6" }, "peerDependencies": { "@babel/core": "^7.0.0" } }, "sha512-/wHc/paTUmsDYN7SZkpWxogTOBNnlx7nBQYfy6JJlCT7G3mVhltk3e++N7zV0XfgGsrqBxd4rJQt9H16I21Y1Q=="], - - "@babel/preset-env": ["@babel/preset-env@7.29.2", "", { "dependencies": { "@babel/compat-data": "^7.29.0", "@babel/helper-compilation-targets": "^7.28.6", "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-validator-option": "^7.27.1", "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", "@babel/plugin-syntax-import-assertions": "^7.28.6", "@babel/plugin-syntax-import-attributes": "^7.28.6", "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", "@babel/plugin-transform-arrow-functions": "^7.27.1", "@babel/plugin-transform-async-generator-functions": "^7.29.0", "@babel/plugin-transform-async-to-generator": "^7.28.6", "@babel/plugin-transform-block-scoped-functions": "^7.27.1", "@babel/plugin-transform-block-scoping": "^7.28.6", "@babel/plugin-transform-class-properties": "^7.28.6", "@babel/plugin-transform-class-static-block": "^7.28.6", "@babel/plugin-transform-classes": "^7.28.6", "@babel/plugin-transform-computed-properties": "^7.28.6", "@babel/plugin-transform-destructuring": "^7.28.5", "@babel/plugin-transform-dotall-regex": "^7.28.6", "@babel/plugin-transform-duplicate-keys": "^7.27.1", "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.0", "@babel/plugin-transform-dynamic-import": "^7.27.1", "@babel/plugin-transform-explicit-resource-management": "^7.28.6", "@babel/plugin-transform-exponentiation-operator": "^7.28.6", "@babel/plugin-transform-export-namespace-from": "^7.27.1", "@babel/plugin-transform-for-of": "^7.27.1", "@babel/plugin-transform-function-name": "^7.27.1", "@babel/plugin-transform-json-strings": "^7.28.6", "@babel/plugin-transform-literals": "^7.27.1", "@babel/plugin-transform-logical-assignment-operators": "^7.28.6", "@babel/plugin-transform-member-expression-literals": "^7.27.1", "@babel/plugin-transform-modules-amd": "^7.27.1", "@babel/plugin-transform-modules-commonjs": "^7.28.6", "@babel/plugin-transform-modules-systemjs": "^7.29.0", "@babel/plugin-transform-modules-umd": "^7.27.1", "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.0", "@babel/plugin-transform-new-target": "^7.27.1", "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", "@babel/plugin-transform-numeric-separator": "^7.28.6", "@babel/plugin-transform-object-rest-spread": "^7.28.6", "@babel/plugin-transform-object-super": "^7.27.1", "@babel/plugin-transform-optional-catch-binding": "^7.28.6", "@babel/plugin-transform-optional-chaining": "^7.28.6", "@babel/plugin-transform-parameters": "^7.27.7", "@babel/plugin-transform-private-methods": "^7.28.6", "@babel/plugin-transform-private-property-in-object": "^7.28.6", "@babel/plugin-transform-property-literals": "^7.27.1", "@babel/plugin-transform-regenerator": "^7.29.0", "@babel/plugin-transform-regexp-modifiers": "^7.28.6", "@babel/plugin-transform-reserved-words": "^7.27.1", "@babel/plugin-transform-shorthand-properties": "^7.27.1", "@babel/plugin-transform-spread": "^7.28.6", "@babel/plugin-transform-sticky-regex": "^7.27.1", "@babel/plugin-transform-template-literals": "^7.27.1", "@babel/plugin-transform-typeof-symbol": "^7.27.1", "@babel/plugin-transform-unicode-escapes": "^7.27.1", "@babel/plugin-transform-unicode-property-regex": "^7.28.6", "@babel/plugin-transform-unicode-regex": "^7.27.1", "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", "@babel/preset-modules": "0.1.6-no-external-plugins", "babel-plugin-polyfill-corejs2": "^0.4.15", "babel-plugin-polyfill-corejs3": "^0.14.0", "babel-plugin-polyfill-regenerator": "^0.6.6", "core-js-compat": "^3.48.0", "semver": "^6.3.1" }, "peerDependencies": { "@babel/core": "^7.0.0-0" } }, "sha512-DYD23veRYGvBFhcTY1iUvJnDNpuqNd/BzBwCvzOTKUnJjKg5kpUBh3/u9585Agdkgj+QuygG7jLfOPWMa2KVNw=="], - - "@babel/preset-modules": ["@babel/preset-modules@0.1.6-no-external-plugins", "", { "dependencies": { "@babel/helper-plugin-utils": "^7.0.0", "@babel/types": "^7.4.4", "esutils": "^2.0.2" }, "peerDependencies": { "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" } }, "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA=="], - - "@babel/template": ["@babel/template@7.28.6", "", { "dependencies": { "@babel/code-frame": "^7.28.6", "@babel/parser": "^7.28.6", "@babel/types": "^7.28.6" } }, "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ=="], - - "@babel/traverse": ["@babel/traverse@7.29.0", "", { "dependencies": { "@babel/code-frame": "^7.29.0", "@babel/generator": "^7.29.0", "@babel/helper-globals": "^7.28.0", "@babel/parser": "^7.29.0", "@babel/template": "^7.28.6", "@babel/types": "^7.29.0", "debug": "^4.3.1" } }, "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA=="], - - "@babel/types": ["@babel/types@7.29.0", "", { "dependencies": { "@babel/helper-string-parser": "^7.27.1", "@babel/helper-validator-identifier": "^7.28.5" } }, "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A=="], - - "@biomejs/biome": ["@biomejs/biome@2.4.13", "", { "optionalDependencies": { "@biomejs/cli-darwin-arm64": "2.4.13", "@biomejs/cli-darwin-x64": "2.4.13", "@biomejs/cli-linux-arm64": "2.4.13", "@biomejs/cli-linux-arm64-musl": "2.4.13", "@biomejs/cli-linux-x64": "2.4.13", "@biomejs/cli-linux-x64-musl": "2.4.13", "@biomejs/cli-win32-arm64": "2.4.13", "@biomejs/cli-win32-x64": "2.4.13" }, "bin": { "biome": "bin/biome" } }, "sha512-gLXOwkOBBg0tr7bDsqlkIh4uFeKuMjxvqsrb1Tukww1iDmHcfr4Uu8MoQxp0Rcte+69+osRNWXwHsu/zxT6XqA=="], - - "@biomejs/cli-darwin-arm64": ["@biomejs/cli-darwin-arm64@2.4.13", "", { "os": "darwin", "cpu": "arm64" }, "sha512-2KImO1jhNFBa2oWConyr0x6flxbQpGKv6902uGXpYM62Xyem8U80j441SyUJ8KyngsmKbQjeIv1q2CQfDkNnYg=="], - - "@biomejs/cli-darwin-x64": ["@biomejs/cli-darwin-x64@2.4.13", "", { "os": "darwin", "cpu": "x64" }, "sha512-BKrJklbaFN4p1Ts4kPBczo+PkbsHQg57kmJ+vON9u2t6uN5okYHaSr7h/MutPCWQgg2lglaWoSmm+zhYW+oOkg=="], - - "@biomejs/cli-linux-arm64": ["@biomejs/cli-linux-arm64@2.4.13", "", { "os": "linux", "cpu": "arm64" }, "sha512-NzkUDSqfvMBrPplKgVr3aXLHZ2NEELvvF4vZxXulEylKWIGqlvNEcwUcj9OLrn75TD3lJ/GIqCVlBwd1MZCuYQ=="], - - "@biomejs/cli-linux-arm64-musl": ["@biomejs/cli-linux-arm64-musl@2.4.13", "", { "os": "linux", "cpu": "arm64" }, "sha512-U5MsuBQW25dXaYtqWWSPM3P96H6Y+fHuja3TQpMNnylocHW0tEbtFTDlUj6oM+YJLntvEkQy4grBvQNUD4+RCg=="], - - "@biomejs/cli-linux-x64": ["@biomejs/cli-linux-x64@2.4.13", "", { "os": "linux", "cpu": "x64" }, "sha512-Az3ZZedYRBo9EQzNnD9SxFcR1G5QsGo6VEc2hIyVPZ1rdKwee/7E9oeBBZFpE8Z44ekxsDQBqbiWGW5ShOhUSQ=="], - - "@biomejs/cli-linux-x64-musl": ["@biomejs/cli-linux-x64-musl@2.4.13", "", { "os": "linux", "cpu": "x64" }, "sha512-Z601MienRgTBDza/+u2CH3RSrWoXo9rtr8NK6A4KJzqGgfxx+H3VlyLgTJ4sRo40T3pIsqpTmiOQEvYzQvBRvQ=="], - - "@biomejs/cli-win32-arm64": ["@biomejs/cli-win32-arm64@2.4.13", "", { "os": "win32", "cpu": "arm64" }, "sha512-Px9PS2B5/Q183bUwy/5VHqp3J2lzdOCeVGzMpphYfl8oSa7VDCqenBdqWpy6DCy/en4Rbf/Y1RieZF6dJPcc9A=="], - - "@biomejs/cli-win32-x64": ["@biomejs/cli-win32-x64@2.4.13", "", { "os": "win32", "cpu": "x64" }, "sha512-tTcMkXyBrmHi9BfrD2VNHs/5rYIUKETqsBlYOvSAABwBkJhSDVb5e7wPukftsQbO3WzQkXe6kaztC6WtUOXSoQ=="], - - "@borewit/text-codec": ["@borewit/text-codec@0.2.2", "", {}, "sha512-DDaRehssg1aNrH4+2hnj1B7vnUGEjU6OIlyRdkMd0aUdIUvKXrJfXsy8LVtXAy7DRvYVluWbMspsRhz2lcW0mQ=="], - - "@bufbuild/protobuf": ["@bufbuild/protobuf@2.12.0", "", {}, "sha512-B/XlCaFIP8LOwzo+bz5uFzATYokcwCKQcghqnlfwSmM5eX/qTkvDBnDPs+gXtX/RyjxJ4DRikECcPJbyALA8FA=="], - - "@cacheable/memory": ["@cacheable/memory@2.0.8", "", { "dependencies": { "@cacheable/utils": "^2.4.0", "@keyv/bigmap": "^1.3.1", "hookified": "^1.15.1", "keyv": "^5.6.0" } }, "sha512-FvEb29x5wVwu/Kf93IWwsOOEuhHh6dYCJF3vcKLzXc0KXIW181AOzv6ceT4ZpBHDvAfG60eqb+ekmrnLHIy+jw=="], - - "@cacheable/utils": ["@cacheable/utils@2.4.1", "", { "dependencies": { "hashery": "^1.5.1", "keyv": "^5.6.0" } }, "sha512-eiFgzCbIneyMlLOmNG4g9xzF7Hv3Mga4LjxjcSC/ues6VYq2+gUbQI8JqNuw/ZM8tJIeIaBGpswAsqV2V7ApgA=="], - - "@cspell/dict-fr-fr": ["@cspell/dict-fr-fr@2.3.2", "", {}, "sha512-cPNjlavSiMfH/bB/Zl5GEF+94s6C77mdvghvVsclco1Ly0VWN3EpH5L9EE3bDGLDpE7m9EnYfRs8TOfZugGrUg=="], - - "@csstools/css-parser-algorithms": ["@csstools/css-parser-algorithms@3.0.5", "", { "peerDependencies": { "@csstools/css-tokenizer": "^3.0.4" } }, "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ=="], - - "@csstools/css-syntax-patches-for-csstree": ["@csstools/css-syntax-patches-for-csstree@1.1.3", "", { "peerDependencies": { "css-tree": "^3.2.1" }, "optionalPeers": ["css-tree"] }, "sha512-SH60bMfrRCJF3morcdk57WklujF4Jr/EsQUzqkarfHXEFcAR1gg7fS/chAE922Sehgzc1/+Tz5H3Ypa1HiEKrg=="], - - "@csstools/css-tokenizer": ["@csstools/css-tokenizer@3.0.4", "", {}, "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw=="], - - "@csstools/media-query-list-parser": ["@csstools/media-query-list-parser@4.0.3", "", { "peerDependencies": { "@csstools/css-parser-algorithms": "^3.0.5", "@csstools/css-tokenizer": "^3.0.4" } }, "sha512-HAYH7d3TLRHDOUQK4mZKf9k9Ph/m8Akstg66ywKR4SFAigjs3yBiUeZtFxywiTm5moZMAp/5W/ZuFnNXXYLuuQ=="], - - "@csstools/selector-specificity": ["@csstools/selector-specificity@5.0.0", "", { "peerDependencies": { "postcss-selector-parser": "^7.0.0" } }, "sha512-PCqQV3c4CoVm3kdPhyeZ07VmBRdH2EpMFA/pd9OASpOEC3aXNGoqPDAZ80D0cLpMBxnmk0+yNhGsEx31hq7Gtw=="], - - "@dual-bundle/import-meta-resolve": ["@dual-bundle/import-meta-resolve@4.2.1", "", {}, "sha512-id+7YRUgoUX6CgV0DtuhirQWodeeA7Lf4i2x71JS/vtA5pRb/hIGWlw+G6MeXvsM+MXrz0VAydTGElX1rAfgPg=="], - - "@effect/language-service": ["@effect/language-service@0.60.0", "", { "bin": { "effect-language-service": "cli.js" } }, "sha512-elJDWHG5Naq3OkilPt9ZRn56JfSA3MhXUIlDx9RWJeScHm96kZ+HkZ3eFBxqROzXwD6Q2DTtFctFwOM0+QLZEA=="], - - "@emnapi/core": ["@emnapi/core@1.10.0", "", { "dependencies": { "@emnapi/wasi-threads": "1.2.1", "tslib": "^2.4.0" } }, "sha512-yq6OkJ4p82CAfPl0u9mQebQHKPJkY7WrIuk205cTYnYe+k2Z8YBh11FrbRG/H6ihirqcacOgl2BIO8oyMQLeXw=="], - - "@emnapi/runtime": ["@emnapi/runtime@1.10.0", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-ewvYlk86xUoGI0zQRNq/mC+16R1QeDlKQy21Ki3oSYXNgLb45GV1P6A0M+/s6nyCuNDqe5VpaY84BzXGwVbwFA=="], - - "@emnapi/wasi-threads": ["@emnapi/wasi-threads@1.2.1", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-uTII7OYF+/Mes/MrcIOYp5yOtSMLBWSIoLPpcgwipoiKbli6k322tcoFsxoIIxPDqW01SQGAgko4EzZi2BNv2w=="], - - "@esbuild/aix-ppc64": ["@esbuild/aix-ppc64@0.27.7", "", { "os": "aix", "cpu": "ppc64" }, "sha512-EKX3Qwmhz1eMdEJokhALr0YiD0lhQNwDqkPYyPhiSwKrh7/4KRjQc04sZ8db+5DVVnZ1LmbNDI1uAMPEUBnQPg=="], - - "@esbuild/android-arm": ["@esbuild/android-arm@0.27.7", "", { "os": "android", "cpu": "arm" }, "sha512-jbPXvB4Yj2yBV7HUfE2KHe4GJX51QplCN1pGbYjvsyCZbQmies29EoJbkEc+vYuU5o45AfQn37vZlyXy4YJ8RQ=="], - - "@esbuild/android-arm64": ["@esbuild/android-arm64@0.27.7", "", { "os": "android", "cpu": "arm64" }, "sha512-62dPZHpIXzvChfvfLJow3q5dDtiNMkwiRzPylSCfriLvZeq0a1bWChrGx/BbUbPwOrsWKMn8idSllklzBy+dgQ=="], - - "@esbuild/android-x64": ["@esbuild/android-x64@0.27.7", "", { "os": "android", "cpu": "x64" }, "sha512-x5VpMODneVDb70PYV2VQOmIUUiBtY3D3mPBG8NxVk5CogneYhkR7MmM3yR/uMdITLrC1ml/NV1rj4bMJuy9MCg=="], - - "@esbuild/darwin-arm64": ["@esbuild/darwin-arm64@0.27.7", "", { "os": "darwin", "cpu": "arm64" }, "sha512-5lckdqeuBPlKUwvoCXIgI2D9/ABmPq3Rdp7IfL70393YgaASt7tbju3Ac+ePVi3KDH6N2RqePfHnXkaDtY9fkw=="], - - "@esbuild/darwin-x64": ["@esbuild/darwin-x64@0.27.7", "", { "os": "darwin", "cpu": "x64" }, "sha512-rYnXrKcXuT7Z+WL5K980jVFdvVKhCHhUwid+dDYQpH+qu+TefcomiMAJpIiC2EM3Rjtq0sO3StMV/+3w3MyyqQ=="], - - "@esbuild/freebsd-arm64": ["@esbuild/freebsd-arm64@0.27.7", "", { "os": "freebsd", "cpu": "arm64" }, "sha512-B48PqeCsEgOtzME2GbNM2roU29AMTuOIN91dsMO30t+Ydis3z/3Ngoj5hhnsOSSwNzS+6JppqWsuhTp6E82l2w=="], - - "@esbuild/freebsd-x64": ["@esbuild/freebsd-x64@0.27.7", "", { "os": "freebsd", "cpu": "x64" }, "sha512-jOBDK5XEjA4m5IJK3bpAQF9/Lelu/Z9ZcdhTRLf4cajlB+8VEhFFRjWgfy3M1O4rO2GQ/b2dLwCUGpiF/eATNQ=="], - - "@esbuild/linux-arm": ["@esbuild/linux-arm@0.27.7", "", { "os": "linux", "cpu": "arm" }, "sha512-RkT/YXYBTSULo3+af8Ib0ykH8u2MBh57o7q/DAs3lTJlyVQkgQvlrPTnjIzzRPQyavxtPtfg0EopvDyIt0j1rA=="], - - "@esbuild/linux-arm64": ["@esbuild/linux-arm64@0.27.7", "", { "os": "linux", "cpu": "arm64" }, "sha512-RZPHBoxXuNnPQO9rvjh5jdkRmVizktkT7TCDkDmQ0W2SwHInKCAV95GRuvdSvA7w4VMwfCjUiPwDi0ZO6Nfe9A=="], - - "@esbuild/linux-ia32": ["@esbuild/linux-ia32@0.27.7", "", { "os": "linux", "cpu": "ia32" }, "sha512-GA48aKNkyQDbd3KtkplYWT102C5sn/EZTY4XROkxONgruHPU72l+gW+FfF8tf2cFjeHaRbWpOYa/uRBz/Xq1Pg=="], - - "@esbuild/linux-loong64": ["@esbuild/linux-loong64@0.27.7", "", { "os": "linux", "cpu": "none" }, "sha512-a4POruNM2oWsD4WKvBSEKGIiWQF8fZOAsycHOt6JBpZ+JN2n2JH9WAv56SOyu9X5IqAjqSIPTaJkqN8F7XOQ5Q=="], - - "@esbuild/linux-mips64el": ["@esbuild/linux-mips64el@0.27.7", "", { "os": "linux", "cpu": "none" }, "sha512-KabT5I6StirGfIz0FMgl1I+R1H73Gp0ofL9A3nG3i/cYFJzKHhouBV5VWK1CSgKvVaG4q1RNpCTR2LuTVB3fIw=="], - - "@esbuild/linux-ppc64": ["@esbuild/linux-ppc64@0.27.7", "", { "os": "linux", "cpu": "ppc64" }, "sha512-gRsL4x6wsGHGRqhtI+ifpN/vpOFTQtnbsupUF5R5YTAg+y/lKelYR1hXbnBdzDjGbMYjVJLJTd2OFmMewAgwlQ=="], - - "@esbuild/linux-riscv64": ["@esbuild/linux-riscv64@0.27.7", "", { "os": "linux", "cpu": "none" }, "sha512-hL25LbxO1QOngGzu2U5xeXtxXcW+/GvMN3ejANqXkxZ/opySAZMrc+9LY/WyjAan41unrR3YrmtTsUpwT66InQ=="], - - "@esbuild/linux-s390x": ["@esbuild/linux-s390x@0.27.7", "", { "os": "linux", "cpu": "s390x" }, "sha512-2k8go8Ycu1Kb46vEelhu1vqEP+UeRVj2zY1pSuPdgvbd5ykAw82Lrro28vXUrRmzEsUV0NzCf54yARIK8r0fdw=="], - - "@esbuild/linux-x64": ["@esbuild/linux-x64@0.27.7", "", { "os": "linux", "cpu": "x64" }, "sha512-hzznmADPt+OmsYzw1EE33ccA+HPdIqiCRq7cQeL1Jlq2gb1+OyWBkMCrYGBJ+sxVzve2ZJEVeePbLM2iEIZSxA=="], - - "@esbuild/netbsd-arm64": ["@esbuild/netbsd-arm64@0.27.7", "", { "os": "none", "cpu": "arm64" }, "sha512-b6pqtrQdigZBwZxAn1UpazEisvwaIDvdbMbmrly7cDTMFnw/+3lVxxCTGOrkPVnsYIosJJXAsILG9XcQS+Yu6w=="], - - "@esbuild/netbsd-x64": ["@esbuild/netbsd-x64@0.27.7", "", { "os": "none", "cpu": "x64" }, "sha512-OfatkLojr6U+WN5EDYuoQhtM+1xco+/6FSzJJnuWiUw5eVcicbyK3dq5EeV/QHT1uy6GoDhGbFpprUiHUYggrw=="], - - "@esbuild/openbsd-arm64": ["@esbuild/openbsd-arm64@0.27.7", "", { "os": "openbsd", "cpu": "arm64" }, "sha512-AFuojMQTxAz75Fo8idVcqoQWEHIXFRbOc1TrVcFSgCZtQfSdc1RXgB3tjOn/krRHENUB4j00bfGjyl2mJrU37A=="], - - "@esbuild/openbsd-x64": ["@esbuild/openbsd-x64@0.27.7", "", { "os": "openbsd", "cpu": "x64" }, "sha512-+A1NJmfM8WNDv5CLVQYJ5PshuRm/4cI6WMZRg1by1GwPIQPCTs1GLEUHwiiQGT5zDdyLiRM/l1G0Pv54gvtKIg=="], - - "@esbuild/openharmony-arm64": ["@esbuild/openharmony-arm64@0.27.7", "", { "os": "none", "cpu": "arm64" }, "sha512-+KrvYb/C8zA9CU/g0sR6w2RBw7IGc5J2BPnc3dYc5VJxHCSF1yNMxTV5LQ7GuKteQXZtspjFbiuW5/dOj7H4Yw=="], - - "@esbuild/sunos-x64": ["@esbuild/sunos-x64@0.27.7", "", { "os": "sunos", "cpu": "x64" }, "sha512-ikktIhFBzQNt/QDyOL580ti9+5mL/YZeUPKU2ivGtGjdTYoqz6jObj6nOMfhASpS4GU4Q/Clh1QtxWAvcYKamA=="], - - "@esbuild/win32-arm64": ["@esbuild/win32-arm64@0.27.7", "", { "os": "win32", "cpu": "arm64" }, "sha512-7yRhbHvPqSpRUV7Q20VuDwbjW5kIMwTHpptuUzV+AA46kiPze5Z7qgt6CLCK3pWFrHeNfDd1VKgyP4O+ng17CA=="], - - "@esbuild/win32-ia32": ["@esbuild/win32-ia32@0.27.7", "", { "os": "win32", "cpu": "ia32" }, "sha512-SmwKXe6VHIyZYbBLJrhOoCJRB/Z1tckzmgTLfFYOfpMAx63BJEaL9ExI8x7v0oAO3Zh6D/Oi1gVxEYr5oUCFhw=="], - - "@esbuild/win32-x64": ["@esbuild/win32-x64@0.27.7", "", { "os": "win32", "cpu": "x64" }, "sha512-56hiAJPhwQ1R4i+21FVF7V8kSD5zZTdHcVuRFMW0hn753vVfQN8xlx4uOPT4xoGH0Z/oVATuR82AiqSTDIpaHg=="], - - "@eslint-community/eslint-utils": ["@eslint-community/eslint-utils@4.9.1", "", { "dependencies": { "eslint-visitor-keys": "^3.4.3" }, "peerDependencies": { "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" } }, "sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ=="], - - "@eslint-community/regexpp": ["@eslint-community/regexpp@4.12.2", "", {}, "sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew=="], - - "@eslint/config-array": ["@eslint/config-array@0.21.2", "", { "dependencies": { "@eslint/object-schema": "^2.1.7", "debug": "^4.3.1", "minimatch": "^3.1.5" } }, "sha512-nJl2KGTlrf9GjLimgIru+V/mzgSK0ABCDQRvxw5BjURL7WfH5uoWmizbH7QB6MmnMBd8cIC9uceWnezL1VZWWw=="], - - "@eslint/config-helpers": ["@eslint/config-helpers@0.4.2", "", { "dependencies": { "@eslint/core": "^0.17.0" } }, "sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw=="], - - "@eslint/core": ["@eslint/core@0.17.0", "", { "dependencies": { "@types/json-schema": "^7.0.15" } }, "sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ=="], - - "@eslint/eslintrc": ["@eslint/eslintrc@3.3.5", "", { "dependencies": { "ajv": "^6.14.0", "debug": "^4.3.2", "espree": "^10.0.1", "globals": "^14.0.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", "js-yaml": "^4.1.1", "minimatch": "^3.1.5", "strip-json-comments": "^3.1.1" } }, "sha512-4IlJx0X0qftVsN5E+/vGujTRIFtwuLbNsVUe7TO6zYPDR1O6nFwvwhIKEKSrl6dZchmYBITazxKoUYOjdtjlRg=="], - - "@eslint/js": ["@eslint/js@9.39.4", "", {}, "sha512-nE7DEIchvtiFTwBw4Lfbu59PG+kCofhjsKaCWzxTpt4lfRjRMqG6uMBzKXuEcyXhOHoUp9riAm7/aWYGhXZ9cw=="], - - "@eslint/object-schema": ["@eslint/object-schema@2.1.7", "", {}, "sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA=="], - - "@eslint/plugin-kit": ["@eslint/plugin-kit@0.4.1", "", { "dependencies": { "@eslint/core": "^0.17.0", "levn": "^0.4.1" } }, "sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA=="], - - "@humanfs/core": ["@humanfs/core@0.19.2", "", { "dependencies": { "@humanfs/types": "^0.15.0" } }, "sha512-UhXNm+CFMWcbChXywFwkmhqjs3PRCmcSa/hfBgLIb7oQ5HNb1wS0icWsGtSAUNgefHeI+eBrA8I1fxmbHsGdvA=="], - - "@humanfs/node": ["@humanfs/node@0.16.8", "", { "dependencies": { "@humanfs/core": "^0.19.2", "@humanfs/types": "^0.15.0", "@humanwhocodes/retry": "^0.4.0" } }, "sha512-gE1eQNZ3R++kTzFUpdGlpmy8kDZD/MLyHqDwqjkVQI0JMdI1D51sy1H958PNXYkM2rAac7e5/CnIKZrHtPh3BQ=="], - - "@humanfs/types": ["@humanfs/types@0.15.0", "", {}, "sha512-ZZ1w0aoQkwuUuC7Yf+7sdeaNfqQiiLcSRbfI08oAxqLtpXQr9AIVX7Ay7HLDuiLYAaFPu8oBYNq/QIi9URHJ3Q=="], - - "@humanwhocodes/module-importer": ["@humanwhocodes/module-importer@1.0.1", "", {}, "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA=="], - - "@humanwhocodes/retry": ["@humanwhocodes/retry@0.4.3", "", {}, "sha512-bV0Tgo9K4hfPCek+aMAn81RppFKv2ySDQeMoSZuvTASywNTnVJCArCZE2FWqpvIatKu7VMRLWlR1EazvVhDyhQ=="], - - "@jridgewell/gen-mapping": ["@jridgewell/gen-mapping@0.3.13", "", { "dependencies": { "@jridgewell/sourcemap-codec": "^1.5.0", "@jridgewell/trace-mapping": "^0.3.24" } }, "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA=="], - - "@jridgewell/remapping": ["@jridgewell/remapping@2.3.5", "", { "dependencies": { "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.24" } }, "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ=="], - - "@jridgewell/resolve-uri": ["@jridgewell/resolve-uri@3.1.2", "", {}, "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw=="], - - "@jridgewell/source-map": ["@jridgewell/source-map@0.3.11", "", { "dependencies": { "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.25" } }, "sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA=="], - - "@jridgewell/sourcemap-codec": ["@jridgewell/sourcemap-codec@1.5.5", "", {}, "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og=="], - - "@jridgewell/trace-mapping": ["@jridgewell/trace-mapping@0.3.31", "", { "dependencies": { "@jridgewell/resolve-uri": "^3.1.0", "@jridgewell/sourcemap-codec": "^1.4.14" } }, "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw=="], - - "@keyv/bigmap": ["@keyv/bigmap@1.3.1", "", { "dependencies": { "hashery": "^1.4.0", "hookified": "^1.15.0" }, "peerDependencies": { "keyv": "^5.6.0" } }, "sha512-WbzE9sdmQtKy8vrNPa9BRnwZh5UF4s1KTmSK0KUVLo3eff5BlQNNWDnFOouNpKfPKDnms9xynJjsMYjMaT/aFQ=="], - - "@keyv/serialize": ["@keyv/serialize@1.1.1", "", {}, "sha512-dXn3FZhPv0US+7dtJsIi2R+c7qWYiReoEh5zUntWCf4oSpMNib8FDhSoed6m3QyZdx5hK7iLFkYk3rNxwt8vTA=="], - - "@logtape/logtape": ["@logtape/logtape@1.3.7", "", {}, "sha512-YgF+q9op97oLLPwc7TcTNIllTArVtTwkwyKky6XVzAXQcBrvFXXtMuwJSryONAyOUSItrx994O/HABOrszZyFg=="], - - "@mobily/ts-belt": ["@mobily/ts-belt@4.0.0-rc.5", "", {}, "sha512-HLWJ8yKrfwdMzCvckRunrAL8Z+K5q31FdY6JzhkBp8o6uQsVuzf26KFyno1s6n6GB78OJEsjs57SaDk9plsJhA=="], - - "@napi-rs/nice": ["@napi-rs/nice@1.1.1", "", { "optionalDependencies": { "@napi-rs/nice-android-arm-eabi": "1.1.1", "@napi-rs/nice-android-arm64": "1.1.1", "@napi-rs/nice-darwin-arm64": "1.1.1", "@napi-rs/nice-darwin-x64": "1.1.1", "@napi-rs/nice-freebsd-x64": "1.1.1", "@napi-rs/nice-linux-arm-gnueabihf": "1.1.1", "@napi-rs/nice-linux-arm64-gnu": "1.1.1", "@napi-rs/nice-linux-arm64-musl": "1.1.1", "@napi-rs/nice-linux-ppc64-gnu": "1.1.1", "@napi-rs/nice-linux-riscv64-gnu": "1.1.1", "@napi-rs/nice-linux-s390x-gnu": "1.1.1", "@napi-rs/nice-linux-x64-gnu": "1.1.1", "@napi-rs/nice-linux-x64-musl": "1.1.1", "@napi-rs/nice-openharmony-arm64": "1.1.1", "@napi-rs/nice-win32-arm64-msvc": "1.1.1", "@napi-rs/nice-win32-ia32-msvc": "1.1.1", "@napi-rs/nice-win32-x64-msvc": "1.1.1" } }, "sha512-xJIPs+bYuc9ASBl+cvGsKbGrJmS6fAKaSZCnT0lhahT5rhA2VVy9/EcIgd2JhtEuFOJNx7UHNn/qiTPTY4nrQw=="], - - "@napi-rs/nice-android-arm-eabi": ["@napi-rs/nice-android-arm-eabi@1.1.1", "", { "os": "android", "cpu": "arm" }, "sha512-kjirL3N6TnRPv5iuHw36wnucNqXAO46dzK9oPb0wj076R5Xm8PfUVA9nAFB5ZNMmfJQJVKACAPd/Z2KYMppthw=="], - - "@napi-rs/nice-android-arm64": ["@napi-rs/nice-android-arm64@1.1.1", "", { "os": "android", "cpu": "arm64" }, "sha512-blG0i7dXgbInN5urONoUCNf+DUEAavRffrO7fZSeoRMJc5qD+BJeNcpr54msPF6qfDD6kzs9AQJogZvT2KD5nw=="], - - "@napi-rs/nice-darwin-arm64": ["@napi-rs/nice-darwin-arm64@1.1.1", "", { "os": "darwin", "cpu": "arm64" }, "sha512-s/E7w45NaLqTGuOjC2p96pct4jRfo61xb9bU1unM/MJ/RFkKlJyJDx7OJI/O0ll/hrfpqKopuAFDV8yo0hfT7A=="], - - "@napi-rs/nice-darwin-x64": ["@napi-rs/nice-darwin-x64@1.1.1", "", { "os": "darwin", "cpu": "x64" }, "sha512-dGoEBnVpsdcC+oHHmW1LRK5eiyzLwdgNQq3BmZIav+9/5WTZwBYX7r5ZkQC07Nxd3KHOCkgbHSh4wPkH1N1LiQ=="], - - "@napi-rs/nice-freebsd-x64": ["@napi-rs/nice-freebsd-x64@1.1.1", "", { "os": "freebsd", "cpu": "x64" }, "sha512-kHv4kEHAylMYmlNwcQcDtXjklYp4FCf0b05E+0h6nDHsZ+F0bDe04U/tXNOqrx5CmIAth4vwfkjjUmp4c4JktQ=="], - - "@napi-rs/nice-linux-arm-gnueabihf": ["@napi-rs/nice-linux-arm-gnueabihf@1.1.1", "", { "os": "linux", "cpu": "arm" }, "sha512-E1t7K0efyKXZDoZg1LzCOLxgolxV58HCkaEkEvIYQx12ht2pa8hoBo+4OB3qh7e+QiBlp1SRf+voWUZFxyhyqg=="], - - "@napi-rs/nice-linux-arm64-gnu": ["@napi-rs/nice-linux-arm64-gnu@1.1.1", "", { "os": "linux", "cpu": "arm64" }, "sha512-CIKLA12DTIZlmTaaKhQP88R3Xao+gyJxNWEn04wZwC2wmRapNnxCUZkVwggInMJvtVElA+D4ZzOU5sX4jV+SmQ=="], - - "@napi-rs/nice-linux-arm64-musl": ["@napi-rs/nice-linux-arm64-musl@1.1.1", "", { "os": "linux", "cpu": "arm64" }, "sha512-+2Rzdb3nTIYZ0YJF43qf2twhqOCkiSrHx2Pg6DJaCPYhhaxbLcdlV8hCRMHghQ+EtZQWGNcS2xF4KxBhSGeutg=="], - - "@napi-rs/nice-linux-ppc64-gnu": ["@napi-rs/nice-linux-ppc64-gnu@1.1.1", "", { "os": "linux", "cpu": "ppc64" }, "sha512-4FS8oc0GeHpwvv4tKciKkw3Y4jKsL7FRhaOeiPei0X9T4Jd619wHNe4xCLmN2EMgZoeGg+Q7GY7BsvwKpL22Tg=="], - - "@napi-rs/nice-linux-riscv64-gnu": ["@napi-rs/nice-linux-riscv64-gnu@1.1.1", "", { "os": "linux", "cpu": "none" }, "sha512-HU0nw9uD4FO/oGCCk409tCi5IzIZpH2agE6nN4fqpwVlCn5BOq0MS1dXGjXaG17JaAvrlpV5ZeyZwSon10XOXw=="], - - "@napi-rs/nice-linux-s390x-gnu": ["@napi-rs/nice-linux-s390x-gnu@1.1.1", "", { "os": "linux", "cpu": "s390x" }, "sha512-2YqKJWWl24EwrX0DzCQgPLKQBxYDdBxOHot1KWEq7aY2uYeX+Uvtv4I8xFVVygJDgf6/92h9N3Y43WPx8+PAgQ=="], - - "@napi-rs/nice-linux-x64-gnu": ["@napi-rs/nice-linux-x64-gnu@1.1.1", "", { "os": "linux", "cpu": "x64" }, "sha512-/gaNz3R92t+dcrfCw/96pDopcmec7oCcAQ3l/M+Zxr82KT4DljD37CpgrnXV+pJC263JkW572pdbP3hP+KjcIg=="], - - "@napi-rs/nice-linux-x64-musl": ["@napi-rs/nice-linux-x64-musl@1.1.1", "", { "os": "linux", "cpu": "x64" }, "sha512-xScCGnyj/oppsNPMnevsBe3pvNaoK7FGvMjT35riz9YdhB2WtTG47ZlbxtOLpjeO9SqqQ2J2igCmz6IJOD5JYw=="], - - "@napi-rs/nice-openharmony-arm64": ["@napi-rs/nice-openharmony-arm64@1.1.1", "", { "os": "none", "cpu": "arm64" }, "sha512-6uJPRVwVCLDeoOaNyeiW0gp2kFIM4r7PL2MczdZQHkFi9gVlgm+Vn+V6nTWRcu856mJ2WjYJiumEajfSm7arPQ=="], - - "@napi-rs/nice-win32-arm64-msvc": ["@napi-rs/nice-win32-arm64-msvc@1.1.1", "", { "os": "win32", "cpu": "arm64" }, "sha512-uoTb4eAvM5B2aj/z8j+Nv8OttPf2m+HVx3UjA5jcFxASvNhQriyCQF1OB1lHL43ZhW+VwZlgvjmP5qF3+59atA=="], - - "@napi-rs/nice-win32-ia32-msvc": ["@napi-rs/nice-win32-ia32-msvc@1.1.1", "", { "os": "win32", "cpu": "ia32" }, "sha512-CNQqlQT9MwuCsg1Vd/oKXiuH+TcsSPJmlAFc5frFyX/KkOh0UpBLEj7aoY656d5UKZQMQFP7vJNa1DNUNORvug=="], - - "@napi-rs/nice-win32-x64-msvc": ["@napi-rs/nice-win32-x64-msvc@1.1.1", "", { "os": "win32", "cpu": "x64" }, "sha512-vB+4G/jBQCAh0jelMTY3+kgFy00Hlx2f2/1zjMoH821IbplbWZOkLiTYXQkygNTzQJTq5cvwBDgn2ppHD+bglQ=="], - - "@napi-rs/wasm-runtime": ["@napi-rs/wasm-runtime@1.1.4", "", { "dependencies": { "@tybys/wasm-util": "^0.10.1" }, "peerDependencies": { "@emnapi/core": "^1.7.1", "@emnapi/runtime": "^1.7.1" } }, "sha512-3NQNNgA1YSlJb/kMH1ildASP9HW7/7kYnRI2szWJaofaS1hWmbGI4H+d3+22aGzXXN9IJ+n+GiFVcGipJP18ow=="], - - "@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=="], - - "@nodelib/fs.stat": ["@nodelib/fs.stat@2.0.5", "", {}, "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A=="], - - "@nodelib/fs.walk": ["@nodelib/fs.walk@1.2.8", "", { "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg=="], - - "@oxc-resolver/binding-android-arm-eabi": ["@oxc-resolver/binding-android-arm-eabi@11.19.1", "", { "os": "android", "cpu": "arm" }, "sha512-aUs47y+xyXHUKlbhqHUjBABjvycq6YSD7bpxSW7vplUmdzAlJ93yXY6ZR0c1o1x5A/QKbENCvs3+NlY8IpIVzg=="], - - "@oxc-resolver/binding-android-arm64": ["@oxc-resolver/binding-android-arm64@11.19.1", "", { "os": "android", "cpu": "arm64" }, "sha512-oolbkRX+m7Pq2LNjr/kKgYeC7bRDMVTWPgxBGMjSpZi/+UskVo4jsMU3MLheZV55jL6c3rNelPl4oD60ggYmqA=="], - - "@oxc-resolver/binding-darwin-arm64": ["@oxc-resolver/binding-darwin-arm64@11.19.1", "", { "os": "darwin", "cpu": "arm64" }, "sha512-nUC6d2i3R5B12sUW4O646qD5cnMXf2oBGPLIIeaRfU9doJRORAbE2SGv4eW6rMqhD+G7nf2Y8TTJTLiiO3Q/dQ=="], - - "@oxc-resolver/binding-darwin-x64": ["@oxc-resolver/binding-darwin-x64@11.19.1", "", { "os": "darwin", "cpu": "x64" }, "sha512-cV50vE5+uAgNcFa3QY1JOeKDSkM/9ReIcc/9wn4TavhW/itkDGrXhw9jaKnkQnGbjJ198Yh5nbX/Gr2mr4Z5jQ=="], - - "@oxc-resolver/binding-freebsd-x64": ["@oxc-resolver/binding-freebsd-x64@11.19.1", "", { "os": "freebsd", "cpu": "x64" }, "sha512-xZOQiYGFxtk48PBKff+Zwoym7ScPAIVp4c14lfLxizO2LTTTJe5sx9vQNGrBymrf/vatSPNMD4FgsaaRigPkqw=="], - - "@oxc-resolver/binding-linux-arm-gnueabihf": ["@oxc-resolver/binding-linux-arm-gnueabihf@11.19.1", "", { "os": "linux", "cpu": "arm" }, "sha512-lXZYWAC6kaGe/ky2su94e9jN9t6M0/6c+GrSlCqL//XO1cxi5lpAhnJYdyrKfm0ZEr/c7RNyAx3P7FSBcBd5+A=="], - - "@oxc-resolver/binding-linux-arm-musleabihf": ["@oxc-resolver/binding-linux-arm-musleabihf@11.19.1", "", { "os": "linux", "cpu": "arm" }, "sha512-veG1kKsuK5+t2IsO9q0DErYVSw2azvCVvWHnfTOS73WE0STdLLB7Q1bB9WR+yHPQM76ASkFyRbogWo1GR1+WbQ=="], - - "@oxc-resolver/binding-linux-arm64-gnu": ["@oxc-resolver/binding-linux-arm64-gnu@11.19.1", "", { "os": "linux", "cpu": "arm64" }, "sha512-heV2+jmXyYnUrpUXSPugqWDRpnsQcDm2AX4wzTuvgdlZfoNYO0O3W2AVpJYaDn9AG4JdM6Kxom8+foE7/BcSig=="], - - "@oxc-resolver/binding-linux-arm64-musl": ["@oxc-resolver/binding-linux-arm64-musl@11.19.1", "", { "os": "linux", "cpu": "arm64" }, "sha512-jvo2Pjs1c9KPxMuMPIeQsgu0mOJF9rEb3y3TdpsrqwxRM+AN6/nDDwv45n5ZrUnQMsdBy5gIabioMKnQfWo9ew=="], - - "@oxc-resolver/binding-linux-ppc64-gnu": ["@oxc-resolver/binding-linux-ppc64-gnu@11.19.1", "", { "os": "linux", "cpu": "ppc64" }, "sha512-vLmdNxWCdN7Uo5suays6A/+ywBby2PWBBPXctWPg5V0+eVuzsJxgAn6MMB4mPlshskYbppjpN2Zg83ArHze9gQ=="], - - "@oxc-resolver/binding-linux-riscv64-gnu": ["@oxc-resolver/binding-linux-riscv64-gnu@11.19.1", "", { "os": "linux", "cpu": "none" }, "sha512-/b+WgR+VTSBxzgOhDO7TlMXC1ufPIMR6Vj1zN+/x+MnyXGW7prTLzU9eW85Aj7Th7CCEG9ArCbTeqxCzFWdg2w=="], - - "@oxc-resolver/binding-linux-riscv64-musl": ["@oxc-resolver/binding-linux-riscv64-musl@11.19.1", "", { "os": "linux", "cpu": "none" }, "sha512-YlRdeWb9j42p29ROh+h4eg/OQ3dTJlpHSa+84pUM9+p6i3djtPz1q55yLJhgW9XfDch7FN1pQ/Vd6YP+xfRIuw=="], - - "@oxc-resolver/binding-linux-s390x-gnu": ["@oxc-resolver/binding-linux-s390x-gnu@11.19.1", "", { "os": "linux", "cpu": "s390x" }, "sha512-EDpafVOQWF8/MJynsjOGFThcqhRHy417sRyLfQmeiamJ8qVhSKAn2Dn2VVKUGCjVB9C46VGjhNo7nOPUi1x6uA=="], - - "@oxc-resolver/binding-linux-x64-gnu": ["@oxc-resolver/binding-linux-x64-gnu@11.19.1", "", { "os": "linux", "cpu": "x64" }, "sha512-NxjZe+rqWhr+RT8/Ik+5ptA3oz7tUw361Wa5RWQXKnfqwSSHdHyrw6IdcTfYuml9dM856AlKWZIUXDmA9kkiBQ=="], - - "@oxc-resolver/binding-linux-x64-musl": ["@oxc-resolver/binding-linux-x64-musl@11.19.1", "", { "os": "linux", "cpu": "x64" }, "sha512-cM/hQwsO3ReJg5kR+SpI69DMfvNCp+A/eVR4b4YClE5bVZwz8rh2Nh05InhwI5HR/9cArbEkzMjcKgTHS6UaNw=="], - - "@oxc-resolver/binding-openharmony-arm64": ["@oxc-resolver/binding-openharmony-arm64@11.19.1", "", { "os": "none", "cpu": "arm64" }, "sha512-QF080IowFB0+9Rh6RcD19bdgh49BpQHUW5TajG1qvWHvmrQznTZZjYlgE2ltLXyKY+qs4F/v5xuX1XS7Is+3qA=="], - - "@oxc-resolver/binding-wasm32-wasi": ["@oxc-resolver/binding-wasm32-wasi@11.19.1", "", { "dependencies": { "@napi-rs/wasm-runtime": "^1.1.1" }, "cpu": "none" }, "sha512-w8UCKhX826cP/ZLokXDS6+milN8y4X7zidsAttEdWlVoamTNf6lhBJldaWr3ukTDiye7s4HRcuPEPOXNC432Vg=="], - - "@oxc-resolver/binding-win32-arm64-msvc": ["@oxc-resolver/binding-win32-arm64-msvc@11.19.1", "", { "os": "win32", "cpu": "arm64" }, "sha512-nJ4AsUVZrVKwnU/QRdzPCCrO0TrabBqgJ8pJhXITdZGYOV28TIYystV1VFLbQ7DtAcaBHpocT5/ZJnF78YJPtQ=="], - - "@oxc-resolver/binding-win32-ia32-msvc": ["@oxc-resolver/binding-win32-ia32-msvc@11.19.1", "", { "os": "win32", "cpu": "ia32" }, "sha512-EW+ND5q2Tl+a3pH81l1QbfgbF3HmqgwLfDfVithRFheac8OTcnbXt/JxqD2GbDkb7xYEqy1zNaVFRr3oeG8npA=="], - - "@oxc-resolver/binding-win32-x64-msvc": ["@oxc-resolver/binding-win32-x64-msvc@11.19.1", "", { "os": "win32", "cpu": "x64" }, "sha512-6hIU3RQu45B+VNTY4Ru8ppFwjVS/S5qwYyGhBotmjxfEKk41I2DlGtRfGJndZ5+6lneE2pwloqunlOyZuX/XAw=="], - - "@oxlint/binding-android-arm-eabi": ["@oxlint/binding-android-arm-eabi@1.61.0", "", { "os": "android", "cpu": "arm" }, "sha512-6eZBPgiigK5txqoVgRqxbaxiom4lM8AP8CyKPPvpzKnQ3iFRFOIDc+0AapF+qsUSwjOzr5SGk4SxQDpQhkSJMQ=="], - - "@oxlint/binding-android-arm64": ["@oxlint/binding-android-arm64@1.61.0", "", { "os": "android", "cpu": "arm64" }, "sha512-CkwLR69MUnyv5wjzebvbbtTSUwqLxM35CXE79bHqDIK+NtKmPEUpStTcLQRZMCo4MP0qRT6TXIQVpK0ZVScnMA=="], - - "@oxlint/binding-darwin-arm64": ["@oxlint/binding-darwin-arm64@1.61.0", "", { "os": "darwin", "cpu": "arm64" }, "sha512-8JbefTkbmvqkqWjmQrHke+MdpgT2UghhD/ktM4FOQSpGeCgbMToJEKdl9zwhr/YWTl92i4QI1KiTwVExpcUN8A=="], - - "@oxlint/binding-darwin-x64": ["@oxlint/binding-darwin-x64@1.61.0", "", { "os": "darwin", "cpu": "x64" }, "sha512-uWpoxDT47hTnDLcdEh5jVbso8rlTTu5o0zuqa9J8E0JAKmIWn7kGFEIB03Pycn2hd2vKxybPGLhjURy/9We5FQ=="], - - "@oxlint/binding-freebsd-x64": ["@oxlint/binding-freebsd-x64@1.61.0", "", { "os": "freebsd", "cpu": "x64" }, "sha512-K/o4hEyW7flfMel0iBVznmMBt7VIMHGdjADocHKpK1DUF9erpWnJ+BSSWd2W0c8K3mPtpph+CuHzRU6CI3l9jQ=="], - - "@oxlint/binding-linux-arm-gnueabihf": ["@oxlint/binding-linux-arm-gnueabihf@1.61.0", "", { "os": "linux", "cpu": "arm" }, "sha512-P6040ZkcyweJ0Po9yEFqJCdvZnf3VNCGs1SIHgXDf8AAQNC6ID/heXQs9iSgo2FH7gKaKq32VWc59XZwL34C5Q=="], - - "@oxlint/binding-linux-arm-musleabihf": ["@oxlint/binding-linux-arm-musleabihf@1.61.0", "", { "os": "linux", "cpu": "arm" }, "sha512-bwxrGCzTZkuB+THv2TQ1aTkVEfv5oz8sl+0XZZCpoYzErJD8OhPQOTA0ENPd1zJz8QsVdSzSrS2umKtPq4/JXg=="], - - "@oxlint/binding-linux-arm64-gnu": ["@oxlint/binding-linux-arm64-gnu@1.61.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-vkhb9/wKguMkLlrm3FoJW/Xmdv31GgYAE+x8lxxQ+7HeOxXUySI0q36a3NTVIuQUdLzxCI1zzMGsk1o37FOe3w=="], - - "@oxlint/binding-linux-arm64-musl": ["@oxlint/binding-linux-arm64-musl@1.61.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-bl1dQh8LnVqsj6oOQAcxwbuOmNJkwc4p6o//HTBZhNTzJy21TLDwAviMqUFNUxDHkPGpmdKTSN4tWTjLryP8xg=="], - - "@oxlint/binding-linux-ppc64-gnu": ["@oxlint/binding-linux-ppc64-gnu@1.61.0", "", { "os": "linux", "cpu": "ppc64" }, "sha512-QoOX6KB2IiEpyOj/HKqaxi+NQHPnOgNgnr22n9N4ANJCzXkUlj1UmeAbFb4PpqdlHIzvGDM5xZ0OKtcLq9RhiQ=="], - - "@oxlint/binding-linux-riscv64-gnu": ["@oxlint/binding-linux-riscv64-gnu@1.61.0", "", { "os": "linux", "cpu": "none" }, "sha512-1TGcTerjY6p152wCof3oKElccq3xHljS/Mucp04gV/4ATpP6nO7YNnp7opEg6SHkv2a57/b4b8Ndm9znJ1/qAw=="], - - "@oxlint/binding-linux-riscv64-musl": ["@oxlint/binding-linux-riscv64-musl@1.61.0", "", { "os": "linux", "cpu": "none" }, "sha512-65wXEmZIrX2ADwC8i/qFL4EWLSbeuBpAm3suuX1vu4IQkKd+wLT/HU/BOl84kp91u2SxPkPDyQgu4yrqp8vwVA=="], - - "@oxlint/binding-linux-s390x-gnu": ["@oxlint/binding-linux-s390x-gnu@1.61.0", "", { "os": "linux", "cpu": "s390x" }, "sha512-TVvhgMvor7Qa6COeXxCJ7ENOM+lcAOGsQ0iUdPSCv2hxb9qSHLQ4XF1h50S6RE1gBOJ0WV3rNukg4JJJP1LWRA=="], - - "@oxlint/binding-linux-x64-gnu": ["@oxlint/binding-linux-x64-gnu@1.61.0", "", { "os": "linux", "cpu": "x64" }, "sha512-SjpS5uYuFoDnDdZPwZE59ndF95AsY47R5MliuneTWR1pDm2CxGJaYXbKULI71t5TVfLQUWmrHEGRL9xvuq6dnA=="], - - "@oxlint/binding-linux-x64-musl": ["@oxlint/binding-linux-x64-musl@1.61.0", "", { "os": "linux", "cpu": "x64" }, "sha512-gGfAeGD4sNJGILZbc/yKcIimO9wQnPMoYp9swAaKeEtwsSQAbU+rsdQze5SBtIP6j0QDzeYd4XSSUCRCF+LIeQ=="], - - "@oxlint/binding-openharmony-arm64": ["@oxlint/binding-openharmony-arm64@1.61.0", "", { "os": "none", "cpu": "arm64" }, "sha512-OlVT0LrG/ct33EVtWRyR+B/othwmDWeRxfi13wUdPeb3lAT5TgTcFDcfLfarZtzB4W1nWF/zICMgYdkggX2WmQ=="], - - "@oxlint/binding-win32-arm64-msvc": ["@oxlint/binding-win32-arm64-msvc@1.61.0", "", { "os": "win32", "cpu": "arm64" }, "sha512-vI//NZPJk6DToiovPtaiwD4iQ7kO1r5ReWQD0sOOyKRtP3E2f6jxin4uvwi3OvDzHA2EFfd7DcZl5dtkQh7g1w=="], - - "@oxlint/binding-win32-ia32-msvc": ["@oxlint/binding-win32-ia32-msvc@1.61.0", "", { "os": "win32", "cpu": "ia32" }, "sha512-0ySj4/4zd2XjePs3XAQq7IigIstN4LPQZgCyigX5/ERMLjdWAJfnxcTsrtxZxuij8guJW8foXuHmhGxW0H4dDA=="], - - "@oxlint/binding-win32-x64-msvc": ["@oxlint/binding-win32-x64-msvc@1.61.0", "", { "os": "win32", "cpu": "x64" }, "sha512-0xgSiyeqDLDZxXoe9CVJrOx3TUVsfyoOY7cNi03JbItNcC9WCZqrSNdrAbHONxhSPaVh/lzfnDcON1RqSUMhHw=="], - - "@parcel/watcher": ["@parcel/watcher@2.5.6", "", { "dependencies": { "detect-libc": "^2.0.3", "is-glob": "^4.0.3", "node-addon-api": "^7.0.0", "picomatch": "^4.0.3" }, "optionalDependencies": { "@parcel/watcher-android-arm64": "2.5.6", "@parcel/watcher-darwin-arm64": "2.5.6", "@parcel/watcher-darwin-x64": "2.5.6", "@parcel/watcher-freebsd-x64": "2.5.6", "@parcel/watcher-linux-arm-glibc": "2.5.6", "@parcel/watcher-linux-arm-musl": "2.5.6", "@parcel/watcher-linux-arm64-glibc": "2.5.6", "@parcel/watcher-linux-arm64-musl": "2.5.6", "@parcel/watcher-linux-x64-glibc": "2.5.6", "@parcel/watcher-linux-x64-musl": "2.5.6", "@parcel/watcher-win32-arm64": "2.5.6", "@parcel/watcher-win32-ia32": "2.5.6", "@parcel/watcher-win32-x64": "2.5.6" } }, "sha512-tmmZ3lQxAe/k/+rNnXQRawJ4NjxO2hqiOLTHvWchtGZULp4RyFeh6aU4XdOYBFe2KE1oShQTv4AblOs2iOrNnQ=="], - - "@parcel/watcher-android-arm64": ["@parcel/watcher-android-arm64@2.5.6", "", { "os": "android", "cpu": "arm64" }, "sha512-YQxSS34tPF/6ZG7r/Ih9xy+kP/WwediEUsqmtf0cuCV5TPPKw/PQHRhueUo6JdeFJaqV3pyjm0GdYjZotbRt/A=="], - - "@parcel/watcher-darwin-arm64": ["@parcel/watcher-darwin-arm64@2.5.6", "", { "os": "darwin", "cpu": "arm64" }, "sha512-Z2ZdrnwyXvvvdtRHLmM4knydIdU9adO3D4n/0cVipF3rRiwP+3/sfzpAwA/qKFL6i1ModaabkU7IbpeMBgiVEA=="], - - "@parcel/watcher-darwin-x64": ["@parcel/watcher-darwin-x64@2.5.6", "", { "os": "darwin", "cpu": "x64" }, "sha512-HgvOf3W9dhithcwOWX9uDZyn1lW9R+7tPZ4sug+NGrGIo4Rk1hAXLEbcH1TQSqxts0NYXXlOWqVpvS1SFS4fRg=="], - - "@parcel/watcher-freebsd-x64": ["@parcel/watcher-freebsd-x64@2.5.6", "", { "os": "freebsd", "cpu": "x64" }, "sha512-vJVi8yd/qzJxEKHkeemh7w3YAn6RJCtYlE4HPMoVnCpIXEzSrxErBW5SJBgKLbXU3WdIpkjBTeUNtyBVn8TRng=="], - - "@parcel/watcher-linux-arm-glibc": ["@parcel/watcher-linux-arm-glibc@2.5.6", "", { "os": "linux", "cpu": "arm" }, "sha512-9JiYfB6h6BgV50CCfasfLf/uvOcJskMSwcdH1PHH9rvS1IrNy8zad6IUVPVUfmXr+u+Km9IxcfMLzgdOudz9EQ=="], - - "@parcel/watcher-linux-arm-musl": ["@parcel/watcher-linux-arm-musl@2.5.6", "", { "os": "linux", "cpu": "arm" }, "sha512-Ve3gUCG57nuUUSyjBq/MAM0CzArtuIOxsBdQ+ftz6ho8n7s1i9E1Nmk/xmP323r2YL0SONs1EuwqBp2u1k5fxg=="], - - "@parcel/watcher-linux-arm64-glibc": ["@parcel/watcher-linux-arm64-glibc@2.5.6", "", { "os": "linux", "cpu": "arm64" }, "sha512-f2g/DT3NhGPdBmMWYoxixqYr3v/UXcmLOYy16Bx0TM20Tchduwr4EaCbmxh1321TABqPGDpS8D/ggOTaljijOA=="], - - "@parcel/watcher-linux-arm64-musl": ["@parcel/watcher-linux-arm64-musl@2.5.6", "", { "os": "linux", "cpu": "arm64" }, "sha512-qb6naMDGlbCwdhLj6hgoVKJl2odL34z2sqkC7Z6kzir8b5W65WYDpLB6R06KabvZdgoHI/zxke4b3zR0wAbDTA=="], - - "@parcel/watcher-linux-x64-glibc": ["@parcel/watcher-linux-x64-glibc@2.5.6", "", { "os": "linux", "cpu": "x64" }, "sha512-kbT5wvNQlx7NaGjzPFu8nVIW1rWqV780O7ZtkjuWaPUgpv2NMFpjYERVi0UYj1msZNyCzGlaCWEtzc+exjMGbQ=="], - - "@parcel/watcher-linux-x64-musl": ["@parcel/watcher-linux-x64-musl@2.5.6", "", { "os": "linux", "cpu": "x64" }, "sha512-1JRFeC+h7RdXwldHzTsmdtYR/Ku8SylLgTU/reMuqdVD7CtLwf0VR1FqeprZ0eHQkO0vqsbvFLXUmYm/uNKJBg=="], - - "@parcel/watcher-win32-arm64": ["@parcel/watcher-win32-arm64@2.5.6", "", { "os": "win32", "cpu": "arm64" }, "sha512-3ukyebjc6eGlw9yRt678DxVF7rjXatWiHvTXqphZLvo7aC5NdEgFufVwjFfY51ijYEWpXbqF5jtrK275z52D4Q=="], - - "@parcel/watcher-win32-ia32": ["@parcel/watcher-win32-ia32@2.5.6", "", { "os": "win32", "cpu": "ia32" }, "sha512-k35yLp1ZMwwee3Ez/pxBi5cf4AoBKYXj00CZ80jUz5h8prpiaQsiRPKQMxoLstNuqe2vR4RNPEAEcjEFzhEz/g=="], - - "@parcel/watcher-win32-x64": ["@parcel/watcher-win32-x64@2.5.6", "", { "os": "win32", "cpu": "x64" }, "sha512-hbQlYcCq5dlAX9Qx+kFb0FHue6vbjlf0FrNzSKdYK2APUf7tGfGxQCk2ihEREmbR6ZMc0MVAD5RIX/41gpUzTw=="], - - "@playwright/test": ["@playwright/test@1.59.1", "", { "dependencies": { "playwright": "1.59.1" }, "bin": { "playwright": "cli.js" } }, "sha512-PG6q63nQg5c9rIi4/Z5lR5IVF7yU5MqmKaPOe0HSc0O2cX1fPi96sUQu5j7eo4gKCkB2AnNGoWt7y4/Xx3Kcqg=="], - - "@prettier/plugin-xml": ["@prettier/plugin-xml@3.4.2", "", { "dependencies": { "@xml-tools/parser": "^1.0.11" }, "peerDependencies": { "prettier": "^3.0.0" } }, "sha512-/UyNlHfkuLXG6Ed85KB0WBF283xn2yavR+UtRibBRUcvEJId2DSLdGXwJ/cDa1X++SWDPzq3+GSFniHjkNy7yg=="], - - "@reteps/dockerfmt": ["@reteps/dockerfmt@0.5.2", "", {}, "sha512-Hbr7yen4fP5TxGM54ucXa4o5NwWXatJ6Bd9I8gp0PValYbI4Rug2Gu+rVv7K7o/efQc3F5ctqWJz47rYaa8zBw=="], - - "@rollup/rollup-android-arm-eabi": ["@rollup/rollup-android-arm-eabi@4.60.2", "", { "os": "android", "cpu": "arm" }, "sha512-dnlp69efPPg6Uaw2dVqzWRfAWRnYVb1XJ8CyyhIbZeaq4CA5/mLeZ1IEt9QqQxmbdvagjLIm2ZL8BxXv5lH4Yw=="], - - "@rollup/rollup-android-arm64": ["@rollup/rollup-android-arm64@4.60.2", "", { "os": "android", "cpu": "arm64" }, "sha512-OqZTwDRDchGRHHm/hwLOL7uVPB9aUvI0am/eQuWMNyFHf5PSEQmyEeYYheA0EPPKUO/l0uigCp+iaTjoLjVoHg=="], - - "@rollup/rollup-darwin-arm64": ["@rollup/rollup-darwin-arm64@4.60.2", "", { "os": "darwin", "cpu": "arm64" }, "sha512-UwRE7CGpvSVEQS8gUMBe1uADWjNnVgP3Iusyda1nSRwNDCsRjnGc7w6El6WLQsXmZTbLZx9cecegumcitNfpmA=="], - - "@rollup/rollup-darwin-x64": ["@rollup/rollup-darwin-x64@4.60.2", "", { "os": "darwin", "cpu": "x64" }, "sha512-gjEtURKLCC5VXm1I+2i1u9OhxFsKAQJKTVB8WvDAHF+oZlq0GTVFOlTlO1q3AlCTE/DF32c16ESvfgqR7343/g=="], - - "@rollup/rollup-freebsd-arm64": ["@rollup/rollup-freebsd-arm64@4.60.2", "", { "os": "freebsd", "cpu": "arm64" }, "sha512-Bcl6CYDeAgE70cqZaMojOi/eK63h5Me97ZqAQoh77VPjMysA/4ORQBRGo3rRy45x4MzVlU9uZxs8Uwy7ZaKnBw=="], - - "@rollup/rollup-freebsd-x64": ["@rollup/rollup-freebsd-x64@4.60.2", "", { "os": "freebsd", "cpu": "x64" }, "sha512-LU+TPda3mAE2QB0/Hp5VyeKJivpC6+tlOXd1VMoXV/YFMvk/MNk5iXeBfB4MQGRWyOYVJ01625vjkr0Az98OJQ=="], - - "@rollup/rollup-linux-arm-gnueabihf": ["@rollup/rollup-linux-arm-gnueabihf@4.60.2", "", { "os": "linux", "cpu": "arm" }, "sha512-2QxQrM+KQ7DAW4o22j+XZ6RKdxjLD7BOWTP0Bv0tmjdyhXSsr2Ul1oJDQqh9Zf5qOwTuTc7Ek83mOFaKnodPjg=="], - - "@rollup/rollup-linux-arm-musleabihf": ["@rollup/rollup-linux-arm-musleabihf@4.60.2", "", { "os": "linux", "cpu": "arm" }, "sha512-TbziEu2DVsTEOPif2mKWkMeDMLoYjx95oESa9fkQQK7r/Orta0gnkcDpzwufEcAO2BLBsD7mZkXGFqEdMRRwfw=="], - - "@rollup/rollup-linux-arm64-gnu": ["@rollup/rollup-linux-arm64-gnu@4.60.2", "", { "os": "linux", "cpu": "arm64" }, "sha512-bO/rVDiDUuM2YfuCUwZ1t1cP+/yqjqz+Xf2VtkdppefuOFS2OSeAfgafaHNkFn0t02hEyXngZkxtGqXcXwO8Rg=="], - - "@rollup/rollup-linux-arm64-musl": ["@rollup/rollup-linux-arm64-musl@4.60.2", "", { "os": "linux", "cpu": "arm64" }, "sha512-hr26p7e93Rl0Za+JwW7EAnwAvKkehh12BU1Llm9Ykiibg4uIr2rbpxG9WCf56GuvidlTG9KiiQT/TXT1yAWxTA=="], - - "@rollup/rollup-linux-loong64-gnu": ["@rollup/rollup-linux-loong64-gnu@4.60.2", "", { "os": "linux", "cpu": "none" }, "sha512-pOjB/uSIyDt+ow3k/RcLvUAOGpysT2phDn7TTUB3n75SlIgZzM6NKAqlErPhoFU+npgY3/n+2HYIQVbF70P9/A=="], - - "@rollup/rollup-linux-loong64-musl": ["@rollup/rollup-linux-loong64-musl@4.60.2", "", { "os": "linux", "cpu": "none" }, "sha512-2/w+q8jszv9Ww1c+6uJT3OwqhdmGP2/4T17cu8WuwyUuuaCDDJ2ojdyYwZzCxx0GcsZBhzi3HmH+J5pZNXnd+Q=="], - - "@rollup/rollup-linux-ppc64-gnu": ["@rollup/rollup-linux-ppc64-gnu@4.60.2", "", { "os": "linux", "cpu": "ppc64" }, "sha512-11+aL5vKheYgczxtPVVRhdptAM2H7fcDR5Gw4/bTcteuZBlH4oP9f5s9zYO9aGZvoGeBpqXI/9TZZihZ609wKw=="], - - "@rollup/rollup-linux-ppc64-musl": ["@rollup/rollup-linux-ppc64-musl@4.60.2", "", { "os": "linux", "cpu": "ppc64" }, "sha512-i16fokAGK46IVZuV8LIIwMdtqhin9hfYkCh8pf8iC3QU3LpwL+1FSFGej+O7l3E/AoknL6Dclh2oTdnRMpTzFQ=="], - - "@rollup/rollup-linux-riscv64-gnu": ["@rollup/rollup-linux-riscv64-gnu@4.60.2", "", { "os": "linux", "cpu": "none" }, "sha512-49FkKS6RGQoriDSK/6E2GkAsAuU5kETFCh7pG4yD/ylj9rKhTmO3elsnmBvRD4PgJPds5W2PkhC82aVwmUcJ7A=="], - - "@rollup/rollup-linux-riscv64-musl": ["@rollup/rollup-linux-riscv64-musl@4.60.2", "", { "os": "linux", "cpu": "none" }, "sha512-mjYNkHPfGpUR00DuM1ZZIgs64Hpf4bWcz9Z41+4Q+pgDx73UwWdAYyf6EG/lRFldmdHHzgrYyge5akFUW0D3mQ=="], - - "@rollup/rollup-linux-s390x-gnu": ["@rollup/rollup-linux-s390x-gnu@4.60.2", "", { "os": "linux", "cpu": "s390x" }, "sha512-ALyvJz965BQk8E9Al/JDKKDLH2kfKFLTGMlgkAbbYtZuJt9LU8DW3ZoDMCtQpXAltZxwBHevXz5u+gf0yA0YoA=="], - - "@rollup/rollup-linux-x64-gnu": ["@rollup/rollup-linux-x64-gnu@4.60.2", "", { "os": "linux", "cpu": "x64" }, "sha512-UQjrkIdWrKI626Du8lCQ6MJp/6V1LAo2bOK9OTu4mSn8GGXIkPXk/Vsp4bLHCd9Z9Iz2OTEaokUE90VweJgIYQ=="], - - "@rollup/rollup-linux-x64-musl": ["@rollup/rollup-linux-x64-musl@4.60.2", "", { "os": "linux", "cpu": "x64" }, "sha512-bTsRGj6VlSdn/XD4CGyzMnzaBs9bsRxy79eTqTCBsA8TMIEky7qg48aPkvJvFe1HyzQ5oMZdg7AnVlWQSKLTnw=="], - - "@rollup/rollup-openbsd-x64": ["@rollup/rollup-openbsd-x64@4.60.2", "", { "os": "openbsd", "cpu": "x64" }, "sha512-6d4Z3534xitaA1FcMWP7mQPq5zGwBmGbhphh2DwaA1aNIXUu3KTOfwrWpbwI4/Gr0uANo7NTtaykFyO2hPuFLg=="], - - "@rollup/rollup-openharmony-arm64": ["@rollup/rollup-openharmony-arm64@4.60.2", "", { "os": "none", "cpu": "arm64" }, "sha512-NetAg5iO2uN7eB8zE5qrZ3CSil+7IJt4WDFLcC75Ymywq1VZVD6qJ6EvNLjZ3rEm6gB7XW5JdT60c6MN35Z85Q=="], - - "@rollup/rollup-win32-arm64-msvc": ["@rollup/rollup-win32-arm64-msvc@4.60.2", "", { "os": "win32", "cpu": "arm64" }, "sha512-NCYhOotpgWZ5kdxCZsv6Iudx0wX8980Q/oW4pNFNihpBKsDbEA1zpkfxJGC0yugsUuyDZ7gL37dbzwhR0VI7pQ=="], - - "@rollup/rollup-win32-ia32-msvc": ["@rollup/rollup-win32-ia32-msvc@4.60.2", "", { "os": "win32", "cpu": "ia32" }, "sha512-RXsaOqXxfoUBQoOgvmmijVxJnW2IGB0eoMO7F8FAjaj0UTywUO/luSqimWBJn04WNgUkeNhh7fs7pESXajWmkg=="], - - "@rollup/rollup-win32-x64-gnu": ["@rollup/rollup-win32-x64-gnu@4.60.2", "", { "os": "win32", "cpu": "x64" }, "sha512-qdAzEULD+/hzObedtmV6iBpdL5TIbKVztGiK7O3/KYSf+HIzU257+MX1EXJcyIiDbMAqmbwaufcYPvyRryeZtA=="], - - "@rollup/rollup-win32-x64-msvc": ["@rollup/rollup-win32-x64-msvc@4.60.2", "", { "os": "win32", "cpu": "x64" }, "sha512-Nd/SgG27WoA9e+/TdK74KnHz852TLa94ovOYySo/yMPuTmpckK/jIF2jSwS3g7ELSKXK13/cVdmg1Z/DaCWKxA=="], - - "@sentry-internal/browser-utils": ["@sentry-internal/browser-utils@10.50.0", "", { "dependencies": { "@sentry/core": "10.50.0" } }, "sha512-42bxyRTxnCmYlWnvz4CxikuQNanw8UNma2WJrtxJ0f1MAJV2GhQGSHDLnA+lvFlmiz6qct3pfen/NXGyOTegTA=="], - - "@sentry-internal/feedback": ["@sentry-internal/feedback@10.50.0", "", { "dependencies": { "@sentry/core": "10.50.0" } }, "sha512-0k9XZF0wn86f77mIO2U3gNNyDZooy139CnEanRzHinrN106vVzvBZ6TUEQoHtoO1fqQxr+nWWVrqV/PXUqk47w=="], - - "@sentry-internal/replay": ["@sentry-internal/replay@10.50.0", "", { "dependencies": { "@sentry-internal/browser-utils": "10.50.0", "@sentry/core": "10.50.0" } }, "sha512-51FYNfnvVLAWw1rrEWPFfwHuMRb9mkVCFGA4J9/un7SpeGBsQDziGB0Di4fsCxI7+EdSBpfLHPF0csKtCCw0oQ=="], - - "@sentry-internal/replay-canvas": ["@sentry-internal/replay-canvas@10.50.0", "", { "dependencies": { "@sentry-internal/replay": "10.50.0", "@sentry/core": "10.50.0" } }, "sha512-jx6RKBmcJSWdI92qDGS/sBv1w+7Cww879Z/moX7bw7ipHa/Ts3iDcB3rgZwvhmi17U+mvYsbJeL2DXkPo3TjPw=="], - - "@sentry/browser": ["@sentry/browser@10.50.0", "", { "dependencies": { "@sentry-internal/browser-utils": "10.50.0", "@sentry-internal/feedback": "10.50.0", "@sentry-internal/replay": "10.50.0", "@sentry-internal/replay-canvas": "10.50.0", "@sentry/core": "10.50.0" } }, "sha512-1f6rAvET6myiTaSeYqvaaBwvq1LfxqWjAPIoAW/NVC9bPMkeEcuvgDajHrnZMrBeWoJ81NMyoLkyX+iOc7MoFA=="], - - "@sentry/core": ["@sentry/core@10.50.0", "", {}, "sha512-J4A+vzUO3adl0TkFCjaN1+4miamrjHiEIYuLHiuu1lmAjq5WIVw32ObvAh4yMwNtxyaEMosTrrh5M6f12XSJFg=="], - - "@sindresorhus/is": ["@sindresorhus/is@5.6.0", "", {}, "sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g=="], - - "@standard-schema/spec": ["@standard-schema/spec@1.1.0", "", {}, "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w=="], - - "@stylistic/stylelint-plugin": ["@stylistic/stylelint-plugin@3.1.3", "", { "dependencies": { "@csstools/css-parser-algorithms": "^3.0.1", "@csstools/css-tokenizer": "^3.0.1", "@csstools/media-query-list-parser": "^3.0.1", "is-plain-object": "^5.0.0", "postcss": "^8.4.41", "postcss-selector-parser": "^6.1.2", "postcss-value-parser": "^4.2.0", "style-search": "^0.1.0" }, "peerDependencies": { "stylelint": "^16.8.0" } }, "sha512-85fsmzgsIVmyG3/GFrjuYj6Cz8rAM7IZiPiXCMiSMfoDOC1lOrzrXPDk24WqviAghnPqGpx8b0caK2PuewWGFg=="], - - "@swc/cli": ["@swc/cli@0.7.8", "", { "dependencies": { "@swc/counter": "^0.1.3", "@xhmikosr/bin-wrapper": "^13.0.5", "commander": "^8.3.0", "minimatch": "^9.0.3", "piscina": "^4.3.1", "semver": "^7.3.8", "slash": "3.0.0", "source-map": "^0.7.3", "tinyglobby": "^0.2.13" }, "peerDependencies": { "@swc/core": "^1.2.66", "chokidar": "^4.0.1" }, "optionalPeers": ["chokidar"], "bin": { "swc": "bin/swc.js", "swcx": "bin/swcx.js", "spack": "bin/spack.js" } }, "sha512-27Ov4rm0s2C6LLX+NDXfDVB69LGs8K94sXtFhgeUyQ4DBywZuCgTBu2loCNHRr8JhT9DeQvJM5j9FAu/THbo4w=="], - - "@swc/core": ["@swc/core@1.15.32", "", { "dependencies": { "@swc/counter": "^0.1.3", "@swc/types": "^0.1.26" }, "optionalDependencies": { "@swc/core-darwin-arm64": "1.15.32", "@swc/core-darwin-x64": "1.15.32", "@swc/core-linux-arm-gnueabihf": "1.15.32", "@swc/core-linux-arm64-gnu": "1.15.32", "@swc/core-linux-arm64-musl": "1.15.32", "@swc/core-linux-ppc64-gnu": "1.15.32", "@swc/core-linux-s390x-gnu": "1.15.32", "@swc/core-linux-x64-gnu": "1.15.32", "@swc/core-linux-x64-musl": "1.15.32", "@swc/core-win32-arm64-msvc": "1.15.32", "@swc/core-win32-ia32-msvc": "1.15.32", "@swc/core-win32-x64-msvc": "1.15.32" }, "peerDependencies": { "@swc/helpers": ">=0.5.17" }, "optionalPeers": ["@swc/helpers"] }, "sha512-/eWL0n43D64QWEUHLtTE+jDqjkJhyidjkDhv6f0uJohOUAhywxQ9wXYp845DNNds0JpCdI4Uo0a9bl+vbXf+ew=="], - - "@swc/core-darwin-arm64": ["@swc/core-darwin-arm64@1.15.32", "", { "os": "darwin", "cpu": "arm64" }, "sha512-/YWMvJDPu+AAwuUsM2G+DNQ/7zhodURGzdQyewEqcvgklAdDHs3LwQmLLnyn6SJl8DT8UOxkbzK+D1PmPeelRg=="], - - "@swc/core-darwin-x64": ["@swc/core-darwin-x64@1.15.32", "", { "os": "darwin", "cpu": "x64" }, "sha512-KOTXJXdAhWL+hZ77MYP3z+4pcMFaQhQ74yqyN1uz093q0YnbxpqMtYpPISbYvMHzVRNNx5kN+9RZAXEaadhWVA=="], - - "@swc/core-linux-arm-gnueabihf": ["@swc/core-linux-arm-gnueabihf@1.15.32", "", { "os": "linux", "cpu": "arm" }, "sha512-oOoxLweljlc0A4X8ybsgxV7cVaYTwBOg2iMDJcFR3Sr48C+lsv9VzSmqdK/IVIXF4W4GjLc3VqTAdSMXlfVLuQ=="], - - "@swc/core-linux-arm64-gnu": ["@swc/core-linux-arm64-gnu@1.15.32", "", { "os": "linux", "cpu": "arm64" }, "sha512-oDzEkdl6D6BAWdMtU5KGO7y3HR5fJcvByNLyEk9+ugj8nP5Ovb7P4kBcStBXc4MPExFGQryehiINMlmY8HlclA=="], - - "@swc/core-linux-arm64-musl": ["@swc/core-linux-arm64-musl@1.15.32", "", { "os": "linux", "cpu": "arm64" }, "sha512-omcqjoZP/b8D8PuczVoRwJieC6ibj7qIxTftNYokz4/aSmKFHvsd7nIFfPk5ZvtzncbH4AY7+Dkr/Lp2gWxYeA=="], - - "@swc/core-linux-ppc64-gnu": ["@swc/core-linux-ppc64-gnu@1.15.32", "", { "os": "linux", "cpu": "ppc64" }, "sha512-KGkTMyz/Tbn3PBNu0AVZ4GTDFKnICrYcTiNPZq8DrvK42pnFsf3GNDrIG9E5AtQlTmC0YigkWKmu0eMcfTrmgA=="], - - "@swc/core-linux-s390x-gnu": ["@swc/core-linux-s390x-gnu@1.15.32", "", { "os": "linux", "cpu": "s390x" }, "sha512-G3Aa4tVS/3OGZBkoNIwUF9F6RAy+Osb4GOlo62SinLmDiErz/ykmM7KH0wkz6l9kM8jJq1HyAM6atJTUEbBk7g=="], - - "@swc/core-linux-x64-gnu": ["@swc/core-linux-x64-gnu@1.15.32", "", { "os": "linux", "cpu": "x64" }, "sha512-ERsjfGcj6CBmj3vJnGDO8m8rTvw6RqMcWo1dogOtNx3/+/0+NNpJiXDobJrr1GwInI/BHAEkvSFIH6d2LqPcUQ=="], - - "@swc/core-linux-x64-musl": ["@swc/core-linux-x64-musl@1.15.32", "", { "os": "linux", "cpu": "x64" }, "sha512-N4Ggahe/8SUbTX50P6EdhbW9YWcgbZVb52R4cq6MK+zsoMjRq7rGvV5ztA05QnbaCYqMYx8rTY7KAIA3Crdo4Q=="], - - "@swc/core-win32-arm64-msvc": ["@swc/core-win32-arm64-msvc@1.15.32", "", { "os": "win32", "cpu": "arm64" }, "sha512-01yN0o9jvo8xBTP12aPK2wW8b41jmOlGbDDlAnoynotc4pO6xA0zby9f1z6j++qXDpGBttLySq1omgVrlQKYcw=="], - - "@swc/core-win32-ia32-msvc": ["@swc/core-win32-ia32-msvc@1.15.32", "", { "os": "win32", "cpu": "ia32" }, "sha512-fLagI9XZYNpTcmlqAcp3KBtmj7E19WCmYD80Jxj1Kn5tGNa7yxNLd3NNdWxuZGUPl5iC0/KqZru7g08gF6Fsrw=="], - - "@swc/core-win32-x64-msvc": ["@swc/core-win32-x64-msvc@1.15.32", "", { "os": "win32", "cpu": "x64" }, "sha512-gbc2bQ/T2CiR+w0OvcVKwLOFAcPZBvmWmolbwpg1E8UrpeC03DGtyMUApOHNXNYWA3SHFrYXCQtosrcMza1YFg=="], - - "@swc/counter": ["@swc/counter@0.1.3", "", {}, "sha512-e2BR4lsJkkRlKZ/qCHPw9ZaSxc0MVUd7gtbtaB7aMvHeJVYe8sOB8DBZkP2DtISHGSku9sCK6T6cnY0CtXrOCQ=="], - - "@swc/types": ["@swc/types@0.1.26", "", { "dependencies": { "@swc/counter": "^0.1.3" } }, "sha512-lyMwd7WGgG79RS7EERZV3T8wMdmPq3xwyg+1nmAM64kIhx5yl+juO2PYIHb7vTiPgPCj8LYjsNV2T5wiQHUEaw=="], - - "@szmarczak/http-timer": ["@szmarczak/http-timer@5.0.1", "", { "dependencies": { "defer-to-connect": "^2.0.1" } }, "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw=="], - - "@tokenizer/inflate": ["@tokenizer/inflate@0.2.7", "", { "dependencies": { "debug": "^4.4.0", "fflate": "^0.8.2", "token-types": "^6.0.0" } }, "sha512-MADQgmZT1eKjp06jpI2yozxaU9uVs4GzzgSL+uEq7bVcJ9V1ZXQkeGNql1fsSI0gMy1vhvNTNbUqrx+pZfJVmg=="], - - "@tokenizer/token": ["@tokenizer/token@0.3.0", "", {}, "sha512-OvjF+z51L3ov0OyAU0duzsYuvO01PH7x4t6DJx+guahgTnBHkhJdG7soQeTSFLWN3efnHyibZ4Z8l2EuWwJN3A=="], - - "@tybys/wasm-util": ["@tybys/wasm-util@0.10.1", "", { "dependencies": { "tslib": "^2.4.0" } }, "sha512-9tTaPJLSiejZKx+Bmog4uSubteqTvFrVrURwkmHixBo0G4seD0zUxp98E1DzUBJxLQ3NPwXrGKDiVjwx/DpPsg=="], - - "@types/eslint__js": ["@types/eslint__js@9.14.0", "", { "dependencies": { "@eslint/js": "*" } }, "sha512-s0jepCjOJWB/GKcuba4jISaVpBudw3ClXJ3fUK4tugChUMQsp6kSwuA8Dcx6wFd/JsJqcY8n4rEpa5RTHs5ypA=="], - - "@types/estree": ["@types/estree@1.0.8", "", {}, "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w=="], - - "@types/http-cache-semantics": ["@types/http-cache-semantics@4.2.0", "", {}, "sha512-L3LgimLHXtGkWikKnsPg0/VFx9OGZaC+eN1u4r+OB1XRqH3meBIAVC2zr1WdMH+RHmnRkqliQAOHNJ/E0j/e0Q=="], - - "@types/json-schema": ["@types/json-schema@7.0.15", "", {}, "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="], - - "@types/node": ["@types/node@24.12.2", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-A1sre26ke7HDIuY/M23nd9gfB+nrmhtYyMINbjI1zHJxYteKR6qSMX56FsmjMcDb3SMcjJg5BiRRgOCC/yBD0g=="], - - "@types/trusted-types": ["@types/trusted-types@2.0.7", "", {}, "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw=="], - - "@typescript-eslint/eslint-plugin": ["@typescript-eslint/eslint-plugin@8.59.0", "", { "dependencies": { "@eslint-community/regexpp": "^4.12.2", "@typescript-eslint/scope-manager": "8.59.0", "@typescript-eslint/type-utils": "8.59.0", "@typescript-eslint/utils": "8.59.0", "@typescript-eslint/visitor-keys": "8.59.0", "ignore": "^7.0.5", "natural-compare": "^1.4.0", "ts-api-utils": "^2.5.0" }, "peerDependencies": { "@typescript-eslint/parser": "^8.59.0", "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-HyAZtpdkgZwpq8Sz3FSUvCR4c+ScbuWa9AksK2Jweub7w4M3yTz4O11AqVJzLYjy/B9ZWPyc81I+mOdJU/bDQw=="], - - "@typescript-eslint/parser": ["@typescript-eslint/parser@8.59.0", "", { "dependencies": { "@typescript-eslint/scope-manager": "8.59.0", "@typescript-eslint/types": "8.59.0", "@typescript-eslint/typescript-estree": "8.59.0", "@typescript-eslint/visitor-keys": "8.59.0", "debug": "^4.4.3" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-TI1XGwKbDpo9tRW8UDIXCOeLk55qe9ZFGs8MTKU6/M08HWTw52DD/IYhfQtOEhEdPhLMT26Ka/x7p70nd3dzDg=="], - - "@typescript-eslint/project-service": ["@typescript-eslint/project-service@8.59.0", "", { "dependencies": { "@typescript-eslint/tsconfig-utils": "^8.59.0", "@typescript-eslint/types": "^8.59.0", "debug": "^4.4.3" }, "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-Lw5ITrR5s5TbC19YSvlr63ZfLaJoU6vtKTHyB0GQOpX0W7d5/Ir6vUahWi/8Sps/nOukZQ0IB3SmlxZnjaKVnw=="], - - "@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.59.0", "", { "dependencies": { "@typescript-eslint/types": "8.59.0", "@typescript-eslint/visitor-keys": "8.59.0" } }, "sha512-UzR16Ut8IpA3Mc4DbgAShlPPkVm8xXMWafXxB0BocaVRHs8ZGakAxGRskF7FId3sdk9lgGD73GSFaWmWFDE4dg=="], - - "@typescript-eslint/tsconfig-utils": ["@typescript-eslint/tsconfig-utils@8.59.0", "", { "peerDependencies": { "typescript": ">=4.8.4 <6.1.0" } }, "sha512-91Sbl3s4Kb3SybliIY6muFBmHVv+pYXfybC4Oolp3dvk8BvIE3wOPc+403CWIT7mJNkfQRGtdqghzs2+Z91Tqg=="], - - "@typescript-eslint/type-utils": ["@typescript-eslint/type-utils@8.59.0", "", { "dependencies": { "@typescript-eslint/types": "8.59.0", "@typescript-eslint/typescript-estree": "8.59.0", "@typescript-eslint/utils": "8.59.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-3TRiZaQSltGqGeNrJzzr1+8YcEobKH9rHnqIp/1psfKFmhRQDNMGP5hBufanYTGznwShzVLs3Mz+gDN7HkWfXg=="], - - "@typescript-eslint/types": ["@typescript-eslint/types@8.59.0", "", {}, "sha512-nLzdsT1gdOgFxxxwrlNVUBzSNBEEHJ86bblmk4QAS6stfig7rcJzWKqCyxFy3YRRHXDWEkb2NralA1nOYkkm/A=="], - - "@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@8.59.0", "", { "dependencies": { "@typescript-eslint/project-service": "8.59.0", "@typescript-eslint/tsconfig-utils": "8.59.0", "@typescript-eslint/types": "8.59.0", "@typescript-eslint/visitor-keys": "8.59.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-O9Re9P1BmBLFJyikRbQpLku/QA3/AueZNO9WePLBwQrvkixTmDe8u76B6CYUAITRl/rHawggEqUGn5QIkVRLMw=="], - - "@typescript-eslint/utils": ["@typescript-eslint/utils@8.59.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.9.1", "@typescript-eslint/scope-manager": "8.59.0", "@typescript-eslint/types": "8.59.0", "@typescript-eslint/typescript-estree": "8.59.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-I1R/K7V07XsMJ12Oaxg/O9GfrysGTmCRhvZJBv0RE0NcULMzjqVpR5kRRQjHsz3J/bElU7HwCO7zkqL+MSUz+g=="], - - "@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.59.0", "", { "dependencies": { "@typescript-eslint/types": "8.59.0", "eslint-visitor-keys": "^5.0.0" } }, "sha512-/uejZt4dSere1bx12WLlPfv8GktzcaDtuJ7s42/HEZ5zGj9oxRaD4bj7qwSunXkf+pbAhFt2zjpHYUiT5lHf0Q=="], - - "@typescript/lib-decorators": ["@better-typescript-lib/decorators@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-/m9Q5Xk66ThUJidTsxmXJH0+49iCLl5PFmue0HkNSGrcPU96oaoKNY5sH1AslwA/OWVvBg3hE58ZwSGm6TQFuQ=="], - - "@typescript/lib-dom": ["@better-typescript-lib/dom@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-via7EW6RKBeUcE9JBS3lNoQeCfghGZoRhBMXOsgOyvBskTdP45MUi6hM7RZMYbTcOh2tzg3j70uhe+1MajCJXw=="], - - "@typescript/lib-es2015": ["@better-typescript-lib/es2015@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-woXTAKb6yUSdy8hm2NQPnvvE0PVQeFLp1rfHrwHlFF/5vG9EjltI9+jdaSN2jtS5sW8SeSQiKCtIZ/AYK/YxQA=="], - - "@typescript/lib-es2016": ["@better-typescript-lib/es2016@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-8V5jFi+qpJbop+xdSEX7PtA6KxUzNXxoN3Lt5MrUB3TLpb/vh6uzphQmYULnkcn1ScdXTzbpHwG4rdNFY36wTA=="], - - "@typescript/lib-es2017": ["@better-typescript-lib/es2017@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-iCUQOIylZwFt+NrkH0LTYzc+LmqRpLkDGLR7zvZs4PlgjONjyYcbyYar2LVbX3XcBsnx7vVW7andI4+aXb+AZQ=="], - - "@typescript/lib-es2018": ["@better-typescript-lib/es2018@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-mch+ACDNKYI8rKBM2AeebejyoI0cK3lpmc7m1yMoPzDOronjGk5sLYryCheLWXeMhUguO13tN5RnlJDyhV1E1A=="], - - "@typescript/lib-es2019": ["@better-typescript-lib/es2019@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-x/+BqehInEYoILfItuHXJdX6hLEOHAUhNlN/x99uN48o6HCKi4teoOaUWlxclcPeS2LmlE4RLzXUylEvd+DPtQ=="], - - "@typescript/lib-es2020": ["@better-typescript-lib/es2020@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-Kc5OPXfLwYnkS+Oa4h8+iPYNdktxMvOum/cW/5WHU4UTtgmShceahbc/9dDsp04fvgTGiT47KHEMuxQYdbx/mQ=="], - - "@typescript/lib-es2021": ["@better-typescript-lib/es2021@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-oc9FxQuHPLYoiNPo0oAAm5PRQEuoLJ39BI1e2jaPLfC1zdc5QbMk517NfKmNb4enlUGKoOhC3uSrpS/OjkSPWw=="], - - "@typescript/lib-es2022": ["@better-typescript-lib/es2022@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-MnqVGp9hmwnCDXv7O8V50rynt+4CU9fPTx2EJ39r0PibzW1dKT7bLdlFNS0+hDFLkJZlV2kgoctP3e5wEBLu7w=="], - - "@typescript/lib-es2023": ["@better-typescript-lib/es2023@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-rB7pbtaxNy9ReKV22lfXfXCfQFCdtxbas+oxcjiTNRYkCcSgc5B3nA3v+NQcbNk1MukhnQca7bmw2tqvKaV8OQ=="], - - "@typescript/lib-es2024": ["@better-typescript-lib/es2024@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-zNCgAaV0hFW1SNeEfvjO7EX35w+Ja16PRP4TFL7ZyENcs93mghQEH9l437Pixya+sG3a2m7GbkFjzv+Z6Bkf5w=="], - - "@typescript/lib-es5": ["@better-typescript-lib/es5@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-TueHgCcwn6QX8MFzC/kx6p7Y9AJUDIwsRz4klOSxGU3l0oUnqSv0uYOrZuLOldeVuVHHfKHKP11I5ELVmWQSNg=="], - - "@typescript/lib-es6": ["@better-typescript-lib/es6@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-zBPoQsg5a1pc2Um5udWadmJRPtH3wR6Z7PMk4q1vQnAn5N3RyzKcvFvNqiQWQXIl0ptSaKN4IVxMzJ+OKi9dUg=="], - - "@typescript/lib-esnext": ["@better-typescript-lib/esnext@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-fOBovlfESsE6bHG8ITAvW3o5qQztryc+8onzRRpDS8gZCOjWX7eNoeM8FlMHplEgWfL0FknKh/o1y7xDXRYhLA=="], - - "@typescript/lib-scripthost": ["@better-typescript-lib/scripthost@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-B5Fz5HARk9G7ntuRawvT+VMwdhN/+OUIuBRW+7IBq3Jk8lzwu53aLSmKK38suGpPikfVhaC1EmA8nPcgHFMlCQ=="], - - "@typescript/lib-webworker": ["@better-typescript-lib/webworker@2.12.0", "", { "peerDependencies": { "typescript": ">=4.5.2" } }, "sha512-YktWJCUYdrRORhd4NgnPZCEzElDglPZzVnfkxGNmEhPpFE1W6ThKDQqkvMZapf3T+0xGeDqJx9V4xhFNnv56Xw=="], - - "@vitejs/plugin-legacy": ["@vitejs/plugin-legacy@7.2.1", "", { "dependencies": { "@babel/core": "^7.28.0", "@babel/plugin-transform-dynamic-import": "^7.27.1", "@babel/plugin-transform-modules-systemjs": "^7.27.1", "@babel/preset-env": "^7.28.0", "babel-plugin-polyfill-corejs3": "^0.13.0", "babel-plugin-polyfill-regenerator": "^0.6.5", "browserslist": "^4.25.1", "browserslist-to-esbuild": "^2.1.1", "core-js": "^3.45.0", "magic-string": "^0.30.17", "regenerator-runtime": "^0.14.1", "systemjs": "^6.15.1" }, "peerDependencies": { "terser": "^5.16.0", "vite": "^7.0.0" } }, "sha512-CaXb/y0mlfu7jQRELEJJc2/5w2bX2m1JraARgFnvSB2yfvnCNJVWWlqAo6WjnKoepOwKx8gs0ugJThPLKCOXIg=="], - - "@xhmikosr/archive-type": ["@xhmikosr/archive-type@7.1.0", "", { "dependencies": { "file-type": "^20.5.0" } }, "sha512-xZEpnGplg1sNPyEgFh0zbHxqlw5dtYg6viplmWSxUj12+QjU9SKu3U/2G73a15pEjLaOqTefNSZ1fOPUOT4Xgg=="], - - "@xhmikosr/bin-check": ["@xhmikosr/bin-check@7.1.0", "", { "dependencies": { "execa": "^5.1.1", "isexe": "^2.0.0" } }, "sha512-y1O95J4mnl+6MpVmKfMYXec17hMEwE/yeCglFNdx+QvLLtP0yN4rSYcbkXnth+lElBuKKek2NbvOfOGPpUXCvw=="], - - "@xhmikosr/bin-wrapper": ["@xhmikosr/bin-wrapper@13.2.0", "", { "dependencies": { "@xhmikosr/bin-check": "^7.1.0", "@xhmikosr/downloader": "^15.2.0", "@xhmikosr/os-filter-obj": "^3.0.0", "bin-version-check": "^5.1.0" } }, "sha512-t9U9X0sDPRGDk5TGx4dv5xiOvniVJpXnfTuynVKwHgtib95NYEw4MkZdJqhoSiz820D9m0o6PCqOPMXz0N9fIw=="], - - "@xhmikosr/decompress": ["@xhmikosr/decompress@10.2.0", "", { "dependencies": { "@xhmikosr/decompress-tar": "^8.1.0", "@xhmikosr/decompress-tarbz2": "^8.1.0", "@xhmikosr/decompress-targz": "^8.1.0", "@xhmikosr/decompress-unzip": "^7.1.0", "graceful-fs": "^4.2.11", "strip-dirs": "^3.0.0" } }, "sha512-MmDBvu0+GmADyQWHolcZuIWffgfnuTo4xpr2I/Qw5Ox0gt+e1Be7oYqJM4te5ylL6mzlcoicnHVDvP27zft8tg=="], - - "@xhmikosr/decompress-tar": ["@xhmikosr/decompress-tar@8.1.0", "", { "dependencies": { "file-type": "^20.5.0", "is-stream": "^2.0.1", "tar-stream": "^3.1.7" } }, "sha512-m0q8x6lwxenh1CrsTby0Jrjq4vzW/QU1OLhTHMQLEdHpmjR1lgahGz++seZI0bXF3XcZw3U3xHfqZSz+JPP2Gg=="], - - "@xhmikosr/decompress-tarbz2": ["@xhmikosr/decompress-tarbz2@8.1.0", "", { "dependencies": { "@xhmikosr/decompress-tar": "^8.0.1", "file-type": "^20.5.0", "is-stream": "^2.0.1", "seek-bzip": "^2.0.0", "unbzip2-stream": "^1.4.3" } }, "sha512-aCLfr3A/FWZnOu5eqnJfme1Z1aumai/WRw55pCvBP+hCGnTFrcpsuiaVN5zmWTR53a8umxncY2JuYsD42QQEbw=="], - - "@xhmikosr/decompress-targz": ["@xhmikosr/decompress-targz@8.1.0", "", { "dependencies": { "@xhmikosr/decompress-tar": "^8.0.1", "file-type": "^20.5.0", "is-stream": "^2.0.1" } }, "sha512-fhClQ2wTmzxzdz2OhSQNo9ExefrAagw93qaG1YggoIz/QpI7atSRa7eOHv4JZkpHWs91XNn8Hry3CwUlBQhfPA=="], - - "@xhmikosr/decompress-unzip": ["@xhmikosr/decompress-unzip@7.1.0", "", { "dependencies": { "file-type": "^20.5.0", "get-stream": "^6.0.1", "yauzl": "^3.1.2" } }, "sha512-oqTYAcObqTlg8owulxFTqiaJkfv2SHsxxxz9Wg4krJAHVzGWlZsU8tAB30R6ow+aHrfv4Kub6WQ8u04NWVPUpA=="], - - "@xhmikosr/downloader": ["@xhmikosr/downloader@15.2.0", "", { "dependencies": { "@xhmikosr/archive-type": "^7.1.0", "@xhmikosr/decompress": "^10.2.0", "content-disposition": "^0.5.4", "defaults": "^2.0.2", "ext-name": "^5.0.0", "file-type": "^20.5.0", "filenamify": "^6.0.0", "get-stream": "^6.0.1", "got": "^13.0.0" } }, "sha512-lAqbig3uRGTt0sHNIM4vUG9HoM+mRl8K28WuYxyXLCUT6pyzl4Y4i0LZ3jMEsCYZ6zjPZbO9XkG91OSTd4si7g=="], - - "@xhmikosr/os-filter-obj": ["@xhmikosr/os-filter-obj@3.0.0", "", { "dependencies": { "arch": "^3.0.0" } }, "sha512-siPY6BD5dQ2SZPl3I0OZBHL27ZqZvLEosObsZRQ1NUB8qcxegwt0T9eKtV96JMFQpIz1elhkzqOg4c/Ri6Dp9A=="], - - "@xml-tools/parser": ["@xml-tools/parser@1.0.11", "", { "dependencies": { "chevrotain": "7.1.1" } }, "sha512-aKqQ077XnR+oQtHJlrAflaZaL7qZsulWc/i/ZEooar5JiWj1eLt0+Wg28cpa+XLney107wXqneC+oG1IZvxkTA=="], - - "a11y-dialog": ["a11y-dialog@8.1.5", "", { "dependencies": { "focusable-selectors": "^0.8.0" } }, "sha512-SlFk3QSqeuvmN/anaIteUkB6ipBHoG1jq5gfQZU2kqvbkDW3Iab7SNufj4io4e8StvuIshD+loJnsQgTEvq6dA=="], - - "acorn": ["acorn@8.16.0", "", { "bin": { "acorn": "bin/acorn" } }, "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw=="], - - "acorn-jsx": ["acorn-jsx@5.3.2", "", { "peerDependencies": { "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ=="], - - "ajv": ["ajv@6.15.0", "", { "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" } }, "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw=="], - - "ansi-regex": ["ansi-regex@5.0.1", "", {}, "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="], - - "ansi-styles": ["ansi-styles@4.3.0", "", { "dependencies": { "color-convert": "^2.0.1" } }, "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg=="], - - "arch": ["arch@3.0.0", "", {}, "sha512-AmIAC+Wtm2AU8lGfTtHsw0Y9Qtftx2YXEEtiBP10xFUtMOA+sHHx6OAddyL52mUKh1vsXQ6/w1mVDptZCyUt4Q=="], - - "argparse": ["argparse@2.0.1", "", {}, "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="], - - "array-union": ["array-union@2.1.0", "", {}, "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw=="], - - "astral-regex": ["astral-regex@2.0.0", "", {}, "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ=="], - - "b4a": ["b4a@1.8.0", "", { "peerDependencies": { "react-native-b4a": "*" }, "optionalPeers": ["react-native-b4a"] }, "sha512-qRuSmNSkGQaHwNbM7J78Wwy+ghLEYF1zNrSeMxj4Kgw6y33O3mXcQ6Ie9fRvfU/YnxWkOchPXbaLb73TkIsfdg=="], - - "babel-plugin-polyfill-corejs2": ["babel-plugin-polyfill-corejs2@0.4.17", "", { "dependencies": { "@babel/compat-data": "^7.28.6", "@babel/helper-define-polyfill-provider": "^0.6.8", "semver": "^6.3.1" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "sha512-aTyf30K/rqAsNwN76zYrdtx8obu0E4KoUME29B1xj+B3WxgvWkp943vYQ+z8Mv3lw9xHXMHpvSPOBxzAkIa94w=="], - - "babel-plugin-polyfill-corejs3": ["babel-plugin-polyfill-corejs3@0.13.0", "", { "dependencies": { "@babel/helper-define-polyfill-provider": "^0.6.5", "core-js-compat": "^3.43.0" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "sha512-U+GNwMdSFgzVmfhNm8GJUX88AadB3uo9KpJqS3FaqNIPKgySuvMb+bHPsOmmuWyIcuqZj/pzt1RUIUZns4y2+A=="], - - "babel-plugin-polyfill-regenerator": ["babel-plugin-polyfill-regenerator@0.6.8", "", { "dependencies": { "@babel/helper-define-polyfill-provider": "^0.6.8" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "sha512-M762rNHfSF1EV3SLtnCJXFoQbbIIz0OyRwnCmV0KPC7qosSfCO0QLTSuJX3ayAebubhE6oYBAYPrBA5ljowaZg=="], - - "balanced-match": ["balanced-match@2.0.0", "", {}, "sha512-1ugUSr8BHXRnK23KfuYS+gVMC3LB8QGH9W1iGtDPsNWoQbgtXSExkBu2aDR4epiGWZOjZsj6lDl/N/AqqTC3UA=="], - - "bare-events": ["bare-events@2.8.2", "", { "peerDependencies": { "bare-abort-controller": "*" }, "optionalPeers": ["bare-abort-controller"] }, "sha512-riJjyv1/mHLIPX4RwiK+oW9/4c3TEUeORHKefKAKnZ5kyslbN+HXowtbaVEqt4IMUB7OXlfixcs6gsFeo/jhiQ=="], - - "bare-fs": ["bare-fs@4.7.1", "", { "dependencies": { "bare-events": "^2.5.4", "bare-path": "^3.0.0", "bare-stream": "^2.6.4", "bare-url": "^2.2.2", "fast-fifo": "^1.3.2" }, "peerDependencies": { "bare-buffer": "*" }, "optionalPeers": ["bare-buffer"] }, "sha512-WDRsyVN52eAx/lBamKD6uyw8H4228h/x0sGGGegOamM2cd7Pag88GfMQalobXI+HaEUxpCkbKQUDOQqt9wawRw=="], - - "bare-os": ["bare-os@3.9.0", "", {}, "sha512-JTjuZyNIDpw+GytMO4a6TK1VXdVKKJr6DRxEHasyuYyShV2deuiHJK/ahGZlebc+SG0/wJCB9XK8gprBGDFi/Q=="], - - "bare-path": ["bare-path@3.0.0", "", { "dependencies": { "bare-os": "^3.0.1" } }, "sha512-tyfW2cQcB5NN8Saijrhqn0Zh7AnFNsnczRcuWODH0eYAXBsJ5gVxAUuNr7tsHSC6IZ77cA0SitzT+s47kot8Mw=="], - - "bare-stream": ["bare-stream@2.13.0", "", { "dependencies": { "streamx": "^2.25.0", "teex": "^1.0.1" }, "peerDependencies": { "bare-abort-controller": "*", "bare-buffer": "*", "bare-events": "*" }, "optionalPeers": ["bare-abort-controller", "bare-buffer", "bare-events"] }, "sha512-3zAJRZMDFGjdn+RVnNpF9kuELw+0Fl3lpndM4NcEOhb9zwtSo/deETfuIwMSE5BXanA0FrN1qVjffGwAg2Y7EA=="], - - "bare-url": ["bare-url@2.4.2", "", { "dependencies": { "bare-path": "^3.0.0" } }, "sha512-/9a2j4ac6ckpmAHvod/ob7x439OAHst/drc2Clnq+reRYd/ovddwcF4LfoxHyNk5AuGBnPg+HqFjmE/Zpq6v0A=="], - - "base64-js": ["base64-js@1.5.1", "", {}, "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA=="], - - "baseline-browser-mapping": ["baseline-browser-mapping@2.10.23", "", { "bin": { "baseline-browser-mapping": "dist/cli.cjs" } }, "sha512-xwVXGqevyKPsiuQdLj+dZMVjidjJV508TBqexND5HrF89cGdCYCJFB3qhcxRHSeMctdCfbR1jrxBajhDy7o29g=="], - - "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=="], - - "bin-version": ["bin-version@6.0.0", "", { "dependencies": { "execa": "^5.0.0", "find-versions": "^5.0.0" } }, "sha512-nk5wEsP4RiKjG+vF+uG8lFsEn4d7Y6FVDamzzftSunXOoOcOOkzcWdKVlGgFFwlUQCj63SgnUkLLGF8v7lufhw=="], - - "bin-version-check": ["bin-version-check@5.1.0", "", { "dependencies": { "bin-version": "^6.0.0", "semver": "^7.5.3", "semver-truncate": "^3.0.0" } }, "sha512-bYsvMqJ8yNGILLz1KP9zKLzQ6YpljV3ln1gqhuLkUtyfGi3qXKGuK2p+U4NAvjVFzDFiBBtOpCOSFNuYYEGZ5g=="], - - "brace-expansion": ["brace-expansion@2.1.0", "", { "dependencies": { "balanced-match": "^1.0.0" } }, "sha512-TN1kCZAgdgweJhWWpgKYrQaMNHcDULHkWwQIspdtjV4Y5aurRdZpjAqn6yX3FPqTA9ngHCc4hJxMAMgGfve85w=="], - - "braces": ["braces@3.0.3", "", { "dependencies": { "fill-range": "^7.1.1" } }, "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA=="], - - "browserslist": ["browserslist@4.28.2", "", { "dependencies": { "baseline-browser-mapping": "^2.10.12", "caniuse-lite": "^1.0.30001782", "electron-to-chromium": "^1.5.328", "node-releases": "^2.0.36", "update-browserslist-db": "^1.2.3" }, "bin": { "browserslist": "cli.js" } }, "sha512-48xSriZYYg+8qXna9kwqjIVzuQxi+KYWp2+5nCYnYKPTr0LvD89Jqk2Or5ogxz0NUMfIjhh2lIUX/LyX9B4oIg=="], - - "browserslist-to-esbuild": ["browserslist-to-esbuild@2.1.1", "", { "dependencies": { "meow": "^13.0.0" }, "peerDependencies": { "browserslist": "*" }, "bin": { "browserslist-to-esbuild": "cli/index.js" } }, "sha512-KN+mty6C3e9AN8Z5dI1xeN15ExcRNeISoC3g7V0Kax/MMF9MSoYA2G7lkTTcVUFntiEjkpI0HNgqJC1NjdyNUw=="], - - "buffer": ["buffer@5.7.1", "", { "dependencies": { "base64-js": "^1.3.1", "ieee754": "^1.1.13" } }, "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ=="], - - "buffer-crc32": ["buffer-crc32@0.2.13", "", {}, "sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ=="], - - "buffer-from": ["buffer-from@1.1.2", "", {}, "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ=="], - - "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=="], - - "cacheable-lookup": ["cacheable-lookup@7.0.0", "", {}, "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w=="], - - "cacheable-request": ["cacheable-request@10.2.14", "", { "dependencies": { "@types/http-cache-semantics": "^4.0.2", "get-stream": "^6.0.1", "http-cache-semantics": "^4.1.1", "keyv": "^4.5.3", "mimic-response": "^4.0.0", "normalize-url": "^8.0.0", "responselike": "^3.0.0" } }, "sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ=="], - - "callsites": ["callsites@3.1.0", "", {}, "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ=="], - - "caniuse-lite": ["caniuse-lite@1.0.30001791", "", {}, "sha512-yk0l/YSrOnFZk3UROpDLQD9+kC1l4meK/wed583AXrzoarMGJcbRi2Q4RaUYbKxYAsZ8sWmaSa/DsLmdBeI1vQ=="], - - "chalk": ["chalk@5.6.2", "", {}, "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA=="], - - "chevrotain": ["chevrotain@7.1.1", "", { "dependencies": { "regexp-to-ast": "0.5.0" } }, "sha512-wy3mC1x4ye+O+QkEinVJkPf5u2vsrDIYW9G7ZuwFl6v/Yu0LwUuT2POsb+NUWApebyxfkQq6+yDfRExbnI5rcw=="], - - "chokidar": ["chokidar@4.0.3", "", { "dependencies": { "readdirp": "^4.0.1" } }, "sha512-Qgzu8kfBvo+cA4962jnP1KkS6Dop5NS6g7R5LFYJr4b8Ub94PPQXUksCw9PvXoeXPRRddRNC5C1JQUR2SMGtnA=="], - - "color-convert": ["color-convert@2.0.1", "", { "dependencies": { "color-name": "~1.1.4" } }, "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ=="], - - "color-name": ["color-name@1.1.4", "", {}, "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="], - - "colord": ["colord@2.9.3", "", {}, "sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw=="], - - "colorjs.io": ["colorjs.io@0.5.2", "", {}, "sha512-twmVoizEW7ylZSN32OgKdXRmo1qg+wT5/6C3xu5b9QsWzSFAhHLn2xd8ro0diCsKfCj1RdaTP/nrcW+vAoQPIw=="], - - "commander": ["commander@8.3.0", "", {}, "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww=="], - - "concat-map": ["concat-map@0.0.1", "", {}, "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="], - - "content-disposition": ["content-disposition@0.5.4", "", { "dependencies": { "safe-buffer": "5.2.1" } }, "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ=="], - - "convert-source-map": ["convert-source-map@2.0.0", "", {}, "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg=="], - - "core-js": ["core-js@3.49.0", "", {}, "sha512-es1U2+YTtzpwkxVLwAFdSpaIMyQaq0PBgm3YD1W3Qpsn1NAmO3KSgZfu+oGSWVu6NvLHoHCV/aYcsE5wiB7ALg=="], - - "core-js-compat": ["core-js-compat@3.49.0", "", { "dependencies": { "browserslist": "^4.28.1" } }, "sha512-VQXt1jr9cBz03b331DFDCCP90b3fanciLkgiOoy8SBHy06gNf+vQ1A3WFLqG7I8TipYIKeYK9wxd0tUrvHcOZA=="], - - "cosmiconfig": ["cosmiconfig@9.0.1", "", { "dependencies": { "env-paths": "^2.2.1", "import-fresh": "^3.3.0", "js-yaml": "^4.1.0", "parse-json": "^5.2.0" }, "peerDependencies": { "typescript": ">=4.9.5" }, "optionalPeers": ["typescript"] }, "sha512-hr4ihw+DBqcvrsEDioRO31Z17x71pUYoNe/4h6Z0wB72p7MU7/9gH8Q3s12NFhHPfYBBOV3qyfUxmr/Yn3shnQ=="], - - "cross-spawn": ["cross-spawn@7.0.6", "", { "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", "which": "^2.0.1" } }, "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA=="], - - "css-functions-list": ["css-functions-list@3.3.3", "", {}, "sha512-8HFEBPKhOpJPEPu70wJJetjKta86Gw9+CCyCnB3sui2qQfOvRyqBy4IKLKKAwdMpWb2lHXWk9Wb4Z6AmaUT1Pg=="], - - "css-tree": ["css-tree@3.2.1", "", { "dependencies": { "mdn-data": "2.27.1", "source-map-js": "^1.2.1" } }, "sha512-X7sjQzceUhu1u7Y/ylrRZFU2FS6LRiFVp6rKLPg23y3x3c3DOKAwuXGDp+PAGjh6CSnCjYeAul8pcT8bAl+lSA=="], - - "cssesc": ["cssesc@3.0.0", "", { "bin": { "cssesc": "bin/cssesc" } }, "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg=="], - - "debug": ["debug@4.4.3", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA=="], - - "decompress-response": ["decompress-response@6.0.0", "", { "dependencies": { "mimic-response": "^3.1.0" } }, "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ=="], - - "deep-is": ["deep-is@0.1.4", "", {}, "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ=="], - - "defaults": ["defaults@2.0.2", "", {}, "sha512-cuIw0PImdp76AOfgkjbW4VhQODRmNNcKR73vdCH5cLd/ifj7aamfoXvYgfGkEAjNJZ3ozMIy9Gu2LutUkGEPbA=="], - - "defer-to-connect": ["defer-to-connect@2.0.1", "", {}, "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg=="], - - "detect-libc": ["detect-libc@2.1.2", "", {}, "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ=="], - - "dir-glob": ["dir-glob@3.0.1", "", { "dependencies": { "path-type": "^4.0.0" } }, "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA=="], - - "effect": ["effect@3.21.2", "", { "dependencies": { "@standard-schema/spec": "^1.0.0", "fast-check": "^3.23.1" } }, "sha512-rXd2FGDM8KdjSIrc+mqEELo7ScW7xTVxEf1iInmPSpIde9/nyGuFM710cjTo7/EreGXiUX2MOonPpprbz2XHCg=="], - - "electron-to-chromium": ["electron-to-chromium@1.5.344", "", {}, "sha512-4MxfbmNDm+KPh066EZy+eUnkcDPcZ35wNmOWzFuh/ijvHsve6kbLTLURy88uCNK5FbpN+yk2nQY6BYh1GEt+wg=="], - - "emoji-regex": ["emoji-regex@8.0.0", "", {}, "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="], - - "env-paths": ["env-paths@2.2.1", "", {}, "sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A=="], - - "error-ex": ["error-ex@1.3.4", "", { "dependencies": { "is-arrayish": "^0.2.1" } }, "sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ=="], - - "es-errors": ["es-errors@1.3.0", "", {}, "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw=="], - - "esbuild": ["esbuild@0.27.7", "", { "optionalDependencies": { "@esbuild/aix-ppc64": "0.27.7", "@esbuild/android-arm": "0.27.7", "@esbuild/android-arm64": "0.27.7", "@esbuild/android-x64": "0.27.7", "@esbuild/darwin-arm64": "0.27.7", "@esbuild/darwin-x64": "0.27.7", "@esbuild/freebsd-arm64": "0.27.7", "@esbuild/freebsd-x64": "0.27.7", "@esbuild/linux-arm": "0.27.7", "@esbuild/linux-arm64": "0.27.7", "@esbuild/linux-ia32": "0.27.7", "@esbuild/linux-loong64": "0.27.7", "@esbuild/linux-mips64el": "0.27.7", "@esbuild/linux-ppc64": "0.27.7", "@esbuild/linux-riscv64": "0.27.7", "@esbuild/linux-s390x": "0.27.7", "@esbuild/linux-x64": "0.27.7", "@esbuild/netbsd-arm64": "0.27.7", "@esbuild/netbsd-x64": "0.27.7", "@esbuild/openbsd-arm64": "0.27.7", "@esbuild/openbsd-x64": "0.27.7", "@esbuild/openharmony-arm64": "0.27.7", "@esbuild/sunos-x64": "0.27.7", "@esbuild/win32-arm64": "0.27.7", "@esbuild/win32-ia32": "0.27.7", "@esbuild/win32-x64": "0.27.7" }, "bin": { "esbuild": "bin/esbuild" } }, "sha512-IxpibTjyVnmrIQo5aqNpCgoACA/dTKLTlhMHihVHhdkxKyPO1uBBthumT0rdHmcsk9uMonIWS0m4FljWzILh3w=="], - - "escalade": ["escalade@3.2.0", "", {}, "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA=="], - - "escape-string-regexp": ["escape-string-regexp@4.0.0", "", {}, "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA=="], - - "eslint": ["eslint@9.39.4", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.2", "@eslint/config-helpers": "^0.4.2", "@eslint/core": "^0.17.0", "@eslint/eslintrc": "^3.3.5", "@eslint/js": "9.39.4", "@eslint/plugin-kit": "^0.4.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", "chalk": "^4.0.0", "cross-spawn": "^7.0.6", "debug": "^4.3.2", "escape-string-regexp": "^4.0.0", "eslint-scope": "^8.4.0", "eslint-visitor-keys": "^4.2.1", "espree": "^10.4.0", "esquery": "^1.5.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", "lodash.merge": "^4.6.2", "minimatch": "^3.1.5", "natural-compare": "^1.4.0", "optionator": "^0.9.3" }, "peerDependencies": { "jiti": "*" }, "optionalPeers": ["jiti"], "bin": { "eslint": "bin/eslint.js" } }, "sha512-XoMjdBOwe/esVgEvLmNsD3IRHkm7fbKIUGvrleloJXUZgDHig2IPWNniv+GwjyJXzuNqVjlr5+4yVUZjycJwfQ=="], - - "eslint-plugin-oxlint": ["eslint-plugin-oxlint@1.61.0", "", { "dependencies": { "jsonc-parser": "^3.3.1" }, "peerDependencies": { "oxlint": "~1.61.0" } }, "sha512-mpROR01MZfs5jRtglHnslLcHYd3/6BNXPJvIxJW/Klg9B5wA8i8EDQp8/FUK7XgpRVa9TpodclqGiwsUYwi/Wg=="], - - "eslint-plugin-perfectionist": ["eslint-plugin-perfectionist@4.15.1", "", { "dependencies": { "@typescript-eslint/types": "^8.38.0", "@typescript-eslint/utils": "^8.38.0", "natural-orderby": "^5.0.0" }, "peerDependencies": { "eslint": ">=8.45.0" } }, "sha512-MHF0cBoOG0XyBf7G0EAFCuJJu4I18wy0zAoT1OHfx2o6EOx1EFTIzr2HGeuZa1kDcusoX0xJ9V7oZmaeFd773Q=="], - - "eslint-scope": ["eslint-scope@8.4.0", "", { "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" } }, "sha512-sNXOfKCn74rt8RICKMvJS7XKV/Xk9kA7DyJr8mJik3S7Cwgy3qlkkmyS2uQB3jiJg6VNdZd/pDBJu0nvG2NlTg=="], - - "eslint-visitor-keys": ["eslint-visitor-keys@4.2.1", "", {}, "sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ=="], - - "espree": ["espree@10.4.0", "", { "dependencies": { "acorn": "^8.15.0", "acorn-jsx": "^5.3.2", "eslint-visitor-keys": "^4.2.1" } }, "sha512-j6PAQ2uUr79PZhBjP5C5fhl8e39FmRnOjsD5lGnWrFU8i2G776tBK7+nP8KuQUTTyAZUwfQqXAgrVH5MbH9CYQ=="], - - "esquery": ["esquery@1.7.0", "", { "dependencies": { "estraverse": "^5.1.0" } }, "sha512-Ap6G0WQwcU/LHsvLwON1fAQX9Zp0A2Y6Y/cJBl9r/JbW90Zyg4/zbG6zzKa2OTALELarYHmKu0GhpM5EO+7T0g=="], - - "esrecurse": ["esrecurse@4.3.0", "", { "dependencies": { "estraverse": "^5.2.0" } }, "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag=="], - - "estraverse": ["estraverse@5.3.0", "", {}, "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA=="], - - "esutils": ["esutils@2.0.3", "", {}, "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g=="], - - "events-universal": ["events-universal@1.0.1", "", { "dependencies": { "bare-events": "^2.7.0" } }, "sha512-LUd5euvbMLpwOF8m6ivPCbhQeSiYVNb8Vs0fQ8QjXo0JTkEHpz8pxdQf0gStltaPpw0Cca8b39KxvK9cfKRiAw=="], - - "execa": ["execa@5.1.1", "", { "dependencies": { "cross-spawn": "^7.0.3", "get-stream": "^6.0.0", "human-signals": "^2.1.0", "is-stream": "^2.0.0", "merge-stream": "^2.0.0", "npm-run-path": "^4.0.1", "onetime": "^5.1.2", "signal-exit": "^3.0.3", "strip-final-newline": "^2.0.0" } }, "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg=="], - - "ext-list": ["ext-list@2.2.2", "", { "dependencies": { "mime-db": "^1.28.0" } }, "sha512-u+SQgsubraE6zItfVA0tBuCBhfU9ogSRnsvygI7wht9TS510oLkBRXBsqopeUG/GBOIQyKZO9wjTqIu/sf5zFA=="], - - "ext-name": ["ext-name@5.0.0", "", { "dependencies": { "ext-list": "^2.0.0", "sort-keys-length": "^1.0.0" } }, "sha512-yblEwXAbGv1VQDmow7s38W77hzAgJAO50ztBLMcUyUBfxv1HC+LGwtiEN+Co6LtlqT/5uwVOxsD4TNIilWhwdQ=="], - - "fast-check": ["fast-check@3.23.2", "", { "dependencies": { "pure-rand": "^6.1.0" } }, "sha512-h5+1OzzfCC3Ef7VbtKdcv7zsstUQwUDlYpUTvjeUsJAssPgLn7QzbboPtL5ro04Mq0rPOsMzl7q5hIbRs2wD1A=="], - - "fast-deep-equal": ["fast-deep-equal@3.1.3", "", {}, "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="], - - "fast-fifo": ["fast-fifo@1.3.2", "", {}, "sha512-/d9sfos4yxzpwkDkuN7k2SqFKtYNmCTzgfEpz82x34IM9/zc8KGxQoXg1liNC/izpRM/MBdt44Nmx41ZWqk+FQ=="], - - "fast-glob": ["fast-glob@3.3.3", "", { "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", "glob-parent": "^5.1.2", "merge2": "^1.3.0", "micromatch": "^4.0.8" } }, "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg=="], - - "fast-json-stable-stringify": ["fast-json-stable-stringify@2.1.0", "", {}, "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw=="], - - "fast-levenshtein": ["fast-levenshtein@2.0.6", "", {}, "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="], - - "fast-uri": ["fast-uri@3.1.0", "", {}, "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA=="], - - "fastest-levenshtein": ["fastest-levenshtein@1.0.16", "", {}, "sha512-eRnCtTTtGZFpQCwhJiUOuxPQWRXVKYDn0b2PeHfXL6/Zi53SLAzAHfVhVWK2AryC/WH05kGfxhFIPvTF0SXQzg=="], - - "fastq": ["fastq@1.20.1", "", { "dependencies": { "reusify": "^1.0.4" } }, "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw=="], - - "fd-package-json": ["fd-package-json@2.0.0", "", { "dependencies": { "walk-up-path": "^4.0.0" } }, "sha512-jKmm9YtsNXN789RS/0mSzOC1NUq9mkVd65vbSSVsKdjGvYXBuE4oWe2QOEoFeRmJg+lPuZxpmrfFclNhoRMneQ=="], - - "fdir": ["fdir@6.5.0", "", { "peerDependencies": { "picomatch": "^3 || ^4" }, "optionalPeers": ["picomatch"] }, "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg=="], - - "fflate": ["fflate@0.8.2", "", {}, "sha512-cPJU47OaAoCbg0pBvzsgpTPhmhqI5eJjh/JIu8tPj5q+T7iLvW/JAYUqmE7KOB4R1ZyEhzBaIQpQpardBF5z8A=="], - - "file-entry-cache": ["file-entry-cache@8.0.0", "", { "dependencies": { "flat-cache": "^4.0.0" } }, "sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ=="], - - "file-type": ["file-type@20.5.0", "", { "dependencies": { "@tokenizer/inflate": "^0.2.6", "strtok3": "^10.2.0", "token-types": "^6.0.0", "uint8array-extras": "^1.4.0" } }, "sha512-BfHZtG/l9iMm4Ecianu7P8HRD2tBHLtjXinm4X62XBOYzi7CYA7jyqfJzOvXHqzVrVPYqBo2/GvbARMaaJkKVg=="], - - "filename-reserved-regex": ["filename-reserved-regex@3.0.0", "", {}, "sha512-hn4cQfU6GOT/7cFHXBqeBg2TbrMBgdD0kcjLhvSQYYwm3s4B6cjvBfb7nBALJLAXqmU5xajSa7X2NnUud/VCdw=="], - - "filenamify": ["filenamify@6.0.0", "", { "dependencies": { "filename-reserved-regex": "^3.0.0" } }, "sha512-vqIlNogKeyD3yzrm0yhRMQg8hOVwYcYRfjEoODd49iCprMn4HL85gK3HcykQE53EPIpX3HcAbGA5ELQv216dAQ=="], - - "fill-range": ["fill-range@7.1.1", "", { "dependencies": { "to-regex-range": "^5.0.1" } }, "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg=="], - - "find-up": ["find-up@5.0.0", "", { "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" } }, "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng=="], - - "find-versions": ["find-versions@5.1.0", "", { "dependencies": { "semver-regex": "^4.0.5" } }, "sha512-+iwzCJ7C5v5KgcBuueqVoNiHVoQpwiUK5XFLjf0affFTep+Wcw93tPvmb8tqujDNmzhBDPddnWV/qgWSXgq+Hg=="], - - "flat-cache": ["flat-cache@4.0.1", "", { "dependencies": { "flatted": "^3.2.9", "keyv": "^4.5.4" } }, "sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw=="], - - "flatted": ["flatted@3.4.2", "", {}, "sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA=="], - - "focusable-selectors": ["focusable-selectors@0.8.4", "", {}, "sha512-0XxbkD0KhOnX10qmnfF9U8DkDD8N/e4M77wMYw2Itoi4vdcoRjSkqXLZFIzkrLIOxzmzCGy88fNG1EbeXMD/zw=="], - - "form-data-encoder": ["form-data-encoder@2.1.4", "", {}, "sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw=="], - - "formatly": ["formatly@0.3.0", "", { "dependencies": { "fd-package-json": "^2.0.0" }, "bin": { "formatly": "bin/index.mjs" } }, "sha512-9XNj/o4wrRFyhSMJOvsuyMwy8aUfBaZ1VrqHVfohyXf0Sw0e+yfKG+xZaY3arGCOMdwFsqObtzVOc1gU9KiT9w=="], - - "fsevents": ["fsevents@2.3.2", "", { "os": "darwin" }, "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA=="], - - "function-bind": ["function-bind@1.1.2", "", {}, "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA=="], - - "gensync": ["gensync@1.0.0-beta.2", "", {}, "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg=="], - - "get-stream": ["get-stream@6.0.1", "", {}, "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg=="], - - "glob-parent": ["glob-parent@6.0.2", "", { "dependencies": { "is-glob": "^4.0.3" } }, "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A=="], - - "global-modules": ["global-modules@2.0.0", "", { "dependencies": { "global-prefix": "^3.0.0" } }, "sha512-NGbfmJBp9x8IxyJSd1P+otYK8vonoJactOogrVfFRIAEY1ukil8RSKDz2Yo7wh1oihl51l/r6W4epkeKJHqL8A=="], - - "global-prefix": ["global-prefix@3.0.0", "", { "dependencies": { "ini": "^1.3.5", "kind-of": "^6.0.2", "which": "^1.3.1" } }, "sha512-awConJSVCHVGND6x3tmMaKcQvwXLhjdkmomy2W+Goaui8YPgYgXJZewhg3fWC+DlfqqQuWg8AwqjGTD2nAPVWg=="], - - "globals": ["globals@16.5.0", "", {}, "sha512-c/c15i26VrJ4IRt5Z89DnIzCGDn9EcebibhAOjw5ibqEHsE1wLUgkPn9RDmNcUKyU87GeaL633nyJ+pplFR2ZQ=="], - - "globby": ["globby@11.1.0", "", { "dependencies": { "array-union": "^2.1.0", "dir-glob": "^3.0.1", "fast-glob": "^3.2.9", "ignore": "^5.2.0", "merge2": "^1.4.1", "slash": "^3.0.0" } }, "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g=="], - - "globjoin": ["globjoin@0.1.4", "", {}, "sha512-xYfnw62CKG8nLkZBfWbhWwDw02CHty86jfPcc2cr3ZfeuK9ysoVPPEUxf21bAD/rWAgk52SuBrLJlefNy8mvFg=="], - - "globrex": ["globrex@0.1.2", "", {}, "sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg=="], - - "got": ["got@13.0.0", "", { "dependencies": { "@sindresorhus/is": "^5.2.0", "@szmarczak/http-timer": "^5.0.1", "cacheable-lookup": "^7.0.0", "cacheable-request": "^10.2.8", "decompress-response": "^6.0.0", "form-data-encoder": "^2.1.2", "get-stream": "^6.0.1", "http2-wrapper": "^2.1.10", "lowercase-keys": "^3.0.0", "p-cancelable": "^3.0.0", "responselike": "^3.0.0" } }, "sha512-XfBk1CxOOScDcMr9O1yKkNaQyy865NbYs+F7dr4H0LZMVgCj2Le59k6PqbNHoL5ToeaEQUYh6c6yMfVcc6SJxA=="], - - "graceful-fs": ["graceful-fs@4.2.11", "", {}, "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ=="], - - "has-flag": ["has-flag@4.0.0", "", {}, "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ=="], - - "hashery": ["hashery@1.5.1", "", { "dependencies": { "hookified": "^1.15.0" } }, "sha512-iZyKG96/JwPz1N55vj2Ie2vXbhu440zfUfJvSwEqEbeLluk7NnapfGqa7LH0mOsnDxTF85Mx8/dyR6HfqcbmbQ=="], - - "hasown": ["hasown@2.0.3", "", { "dependencies": { "function-bind": "^1.1.2" } }, "sha512-ej4AhfhfL2Q2zpMmLo7U1Uv9+PyhIZpgQLGT1F9miIGmiCJIoCgSmczFdrc97mWT4kVY72KA+WnnhJ5pghSvSg=="], - - "hookified": ["hookified@1.15.1", "", {}, "sha512-MvG/clsADq1GPM2KGo2nyfaWVyn9naPiXrqIe4jYjXNZQt238kWyOGrsyc/DmRAQ+Re6yeo6yX/yoNCG5KAEVg=="], - - "html-tags": ["html-tags@3.3.1", "", {}, "sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ=="], - - "http-cache-semantics": ["http-cache-semantics@4.2.0", "", {}, "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ=="], - - "http2-wrapper": ["http2-wrapper@2.2.1", "", { "dependencies": { "quick-lru": "^5.1.1", "resolve-alpn": "^1.2.0" } }, "sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ=="], - - "human-signals": ["human-signals@2.1.0", "", {}, "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw=="], - - "ieee754": ["ieee754@1.2.1", "", {}, "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA=="], - - "ignore": ["ignore@5.3.2", "", {}, "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g=="], - - "immutable": ["immutable@5.1.5", "", {}, "sha512-t7xcm2siw+hlUM68I+UEOK+z84RzmN59as9DZ7P1l0994DKUWV7UXBMQZVxaoMSRQ+PBZbHCOoBt7a2wxOMt+A=="], - - "import-fresh": ["import-fresh@3.3.1", "", { "dependencies": { "parent-module": "^1.0.0", "resolve-from": "^4.0.0" } }, "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ=="], - - "imurmurhash": ["imurmurhash@0.1.4", "", {}, "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA=="], - - "ini": ["ini@1.3.8", "", {}, "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew=="], - - "inspect-with-kind": ["inspect-with-kind@1.0.5", "", { "dependencies": { "kind-of": "^6.0.2" } }, "sha512-MAQUJuIo7Xqk8EVNP+6d3CKq9c80hi4tjIbIAT6lmGW9W6WzlHiu9PS8uSuUYU+Do+j1baiFp3H25XEVxDIG2g=="], - - "is-arrayish": ["is-arrayish@0.2.1", "", {}, "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg=="], - - "is-core-module": ["is-core-module@2.16.1", "", { "dependencies": { "hasown": "^2.0.2" } }, "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w=="], - - "is-extglob": ["is-extglob@2.1.1", "", {}, "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ=="], - - "is-fullwidth-code-point": ["is-fullwidth-code-point@3.0.0", "", {}, "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg=="], - - "is-glob": ["is-glob@4.0.3", "", { "dependencies": { "is-extglob": "^2.1.1" } }, "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg=="], - - "is-number": ["is-number@7.0.0", "", {}, "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng=="], - - "is-plain-obj": ["is-plain-obj@1.1.0", "", {}, "sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg=="], - - "is-plain-object": ["is-plain-object@5.0.0", "", {}, "sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q=="], - - "is-stream": ["is-stream@2.0.1", "", {}, "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg=="], - - "is-unicode-supported": ["is-unicode-supported@2.1.0", "", {}, "sha512-mE00Gnza5EEB3Ds0HfMyllZzbBrmLOX3vfWoj9A9PEnTfratQ/BcaJOuMhnkhjXvb2+FkY3VuHqtAGpTPmglFQ=="], - - "isexe": ["isexe@2.0.0", "", {}, "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="], - - "jiti": ["jiti@2.6.1", "", { "bin": { "jiti": "lib/jiti-cli.mjs" } }, "sha512-ekilCSN1jwRvIbgeg/57YFh8qQDNbwDb9xT/qu2DAHbFFZUicIl4ygVaAvzveMhMVr3LnpSKTNnwt8PoOfmKhQ=="], - - "js-tokens": ["js-tokens@4.0.0", "", {}, "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ=="], - - "js-yaml": ["js-yaml@4.1.1", "", { "dependencies": { "argparse": "^2.0.1" }, "bin": { "js-yaml": "bin/js-yaml.js" } }, "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA=="], - - "jsesc": ["jsesc@3.1.0", "", { "bin": { "jsesc": "bin/jsesc" } }, "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA=="], - - "json-buffer": ["json-buffer@3.0.1", "", {}, "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ=="], - - "json-parse-even-better-errors": ["json-parse-even-better-errors@2.3.1", "", {}, "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w=="], - - "json-schema-traverse": ["json-schema-traverse@0.4.1", "", {}, "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="], - - "json-stable-stringify-without-jsonify": ["json-stable-stringify-without-jsonify@1.0.1", "", {}, "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw=="], - - "json5": ["json5@2.2.3", "", { "bin": { "json5": "lib/cli.js" } }, "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg=="], - - "jsonc-parser": ["jsonc-parser@3.3.1", "", {}, "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ=="], - - "keyv": ["keyv@4.5.4", "", { "dependencies": { "json-buffer": "3.0.1" } }, "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw=="], - - "kind-of": ["kind-of@6.0.3", "", {}, "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="], - - "knip": ["knip@5.88.1", "", { "dependencies": { "@nodelib/fs.walk": "^1.2.3", "fast-glob": "^3.3.3", "formatly": "^0.3.0", "jiti": "^2.6.0", "minimist": "^1.2.8", "oxc-resolver": "^11.19.1", "picocolors": "^1.1.1", "picomatch": "^4.0.1", "smol-toml": "^1.5.2", "strip-json-comments": "5.0.3", "unbash": "^2.2.0", "yaml": "^2.8.2", "zod": "^4.1.11" }, "peerDependencies": { "@types/node": ">=18", "typescript": ">=5.0.4 <7" }, "bin": { "knip": "bin/knip.js", "knip-bun": "bin/knip-bun.js" } }, "sha512-tpy5o7zu1MjawVkLPuahymVJekYY3kYjvzcoInhIchgePxTlo+api90tBv2KfhAIe5uXh+mez1tAfmbv8/TiZg=="], - - "known-css-properties": ["known-css-properties@0.37.0", "", {}, "sha512-JCDrsP4Z1Sb9JwG0aJ8Eo2r7k4Ou5MwmThS/6lcIe1ICyb7UBJKGRIUUdqc2ASdE/42lgz6zFUnzAIhtXnBVrQ=="], - - "levn": ["levn@0.4.1", "", { "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" } }, "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ=="], - - "lightningcss-cli": ["lightningcss-cli@1.32.0", "", { "dependencies": { "detect-libc": "^2.0.3" }, "optionalDependencies": { "lightningcss-cli-android-arm64": "1.32.0", "lightningcss-cli-darwin-arm64": "1.32.0", "lightningcss-cli-darwin-x64": "1.32.0", "lightningcss-cli-freebsd-x64": "1.32.0", "lightningcss-cli-linux-arm-gnueabihf": "1.32.0", "lightningcss-cli-linux-arm64-gnu": "1.32.0", "lightningcss-cli-linux-arm64-musl": "1.32.0", "lightningcss-cli-linux-x64-gnu": "1.32.0", "lightningcss-cli-linux-x64-musl": "1.32.0", "lightningcss-cli-win32-arm64-msvc": "1.32.0", "lightningcss-cli-win32-x64-msvc": "1.32.0" }, "bin": { "lightningcss": "lightningcss" } }, "sha512-IFb/ChmSEbeWU3xeRybR6WFlJXCvfDS84//PUzLrRACgvoWrwRJBmcPS9azSo7LMh5QqEuyKanPBByhKM5z01Q=="], - - "lightningcss-cli-android-arm64": ["lightningcss-cli-android-arm64@1.32.0", "", { "os": "android", "cpu": "arm64" }, "sha512-4O3QY+VdgpBZLIq4crcKOEPVAXX0p7zDoykuTVstRtyolg9XU8CntdtbxcMPSC4SkzAuM/W4KsnPAzmv6Jb5LA=="], - - "lightningcss-cli-darwin-arm64": ["lightningcss-cli-darwin-arm64@1.32.0", "", { "os": "darwin", "cpu": "arm64" }, "sha512-Xx+zeD7bDKJZwbd1N63TJfIUHEtYspf+tqObdnQEJEvZAwmGfA4iEGrkCRT8R57tDRBDSXg3XHMDDvo/cq7gBQ=="], - - "lightningcss-cli-darwin-x64": ["lightningcss-cli-darwin-x64@1.32.0", "", { "os": "darwin", "cpu": "x64" }, "sha512-fYWANZ8RJDpI0tBcPQ7oBOYihfXmgDBHR4lZ6d4z7rcRLlZAOeI00mTO0IXAKfSm/UgnatjM4aBuNlLh8L9noA=="], - - "lightningcss-cli-freebsd-x64": ["lightningcss-cli-freebsd-x64@1.32.0", "", { "os": "freebsd", "cpu": "x64" }, "sha512-TJm7z1Ghvo9FKAza2KvfkFgH/9rcV1xAhCYQZlLrV0CiuTZ17uzLobBWb9oelGWUG+wTnEs6XEl4h/ve61YySg=="], - - "lightningcss-cli-linux-arm-gnueabihf": ["lightningcss-cli-linux-arm-gnueabihf@1.32.0", "", { "os": "linux", "cpu": "arm" }, "sha512-/jS9L5p3eexs5QJvARiDGxibz1umKJmmtff86fWXl3r7RbEUFrMAD4q1WhAR7DurRFgc1YWld6r0mX1YHEYttA=="], - - "lightningcss-cli-linux-arm64-gnu": ["lightningcss-cli-linux-arm64-gnu@1.32.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-PSdjwcRtSrJpsaqnY3ebnCfDOJ5ePi8s/0ItL3CX1b1Eu0iy44xo7MjgES1ZOQ2ntOthPRqaGsbAiVBLbgFLYQ=="], - - "lightningcss-cli-linux-arm64-musl": ["lightningcss-cli-linux-arm64-musl@1.32.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-t6DdpXFtEdonZHzRgH8cmqhC2o4tl0KrD33cDBBniJz5TmWS20MJxb4YEr4WqBLksqW8GE399HJo+g8/YVuKcA=="], - - "lightningcss-cli-linux-x64-gnu": ["lightningcss-cli-linux-x64-gnu@1.32.0", "", { "os": "linux", "cpu": "x64" }, "sha512-QMQllbHYkbkQ4N+v8OGExQlGHBc3YZIcKlVkYucQQj66thkFQsRjmv8p5q3iCB0inNsCoSZ8lBspugkU1iPlPg=="], - - "lightningcss-cli-linux-x64-musl": ["lightningcss-cli-linux-x64-musl@1.32.0", "", { "os": "linux", "cpu": "x64" }, "sha512-dMSWdk4kMAi5f+J1xetxRCDQOvPix2whT0UdjuwP8r/5Xcdl2SQU/c80MQzu1S82kVDEANs1vHVEHp/+26LUnA=="], - - "lightningcss-cli-win32-arm64-msvc": ["lightningcss-cli-win32-arm64-msvc@1.32.0", "", { "os": "win32", "cpu": "arm64" }, "sha512-MJo22OqSp9FLV10nTRDJQhP6zkEBFqBFQe9mnjfCs+G1Ft+QimIPmC+gBqZHFXveOBOsjFLzU72q0FPvRWFmZQ=="], - - "lightningcss-cli-win32-x64-msvc": ["lightningcss-cli-win32-x64-msvc@1.32.0", "", { "os": "win32", "cpu": "x64" }, "sha512-nOBHLPeePXZpGR4Ptp+gkOIkr9pxlq2dFmO954ol5zBi/iOKxuD1hUTIQ7aG+ldKIx4eH9jwoTfZ6owUkm1paA=="], - - "lines-and-columns": ["lines-and-columns@1.2.4", "", {}, "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg=="], - - "lit-html": ["lit-html@3.3.2", "", { "dependencies": { "@types/trusted-types": "^2.0.2" } }, "sha512-Qy9hU88zcmaxBXcc10ZpdK7cOLXvXpRoBxERdtqV9QOrfpMZZ6pSYP91LhpPtap3sFMUiL7Tw2RImbe0Al2/kw=="], - - "locate-path": ["locate-path@6.0.0", "", { "dependencies": { "p-locate": "^5.0.0" } }, "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw=="], - - "lodash.debounce": ["lodash.debounce@4.0.8", "", {}, "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow=="], - - "lodash.merge": ["lodash.merge@4.6.2", "", {}, "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ=="], - - "lodash.truncate": ["lodash.truncate@4.4.2", "", {}, "sha512-jttmRe7bRse52OsWIMDLaXxWqRAmtIUccAQ3garviCqJjafXOfNMO0yMfNpdD6zbGaTU0P5Nz7e7gAT6cKmJRw=="], - - "loglevel": ["loglevel@1.9.2", "", {}, "sha512-HgMmCqIJSAKqo68l0rS2AanEWfkxaZ5wNiEFb5ggm08lDs9Xl2KxBlX3PTcaD2chBM1gXAYf491/M2Rv8Jwayg=="], - - "loglevel-plugin-prefix": ["loglevel-plugin-prefix@0.8.4", "", {}, "sha512-WpG9CcFAOjz/FtNht+QJeGpvVl/cdR6P0z6OcXSkr8wFJOsV2GRj2j10JLfjuA4aYkcKCNIEqRGCyTife9R8/g=="], - - "lowercase-keys": ["lowercase-keys@3.0.0", "", {}, "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ=="], - - "lru-cache": ["lru-cache@5.1.1", "", { "dependencies": { "yallist": "^3.0.2" } }, "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w=="], - - "magic-string": ["magic-string@0.30.21", "", { "dependencies": { "@jridgewell/sourcemap-codec": "^1.5.5" } }, "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ=="], - - "mathml-tag-names": ["mathml-tag-names@2.1.3", "", {}, "sha512-APMBEanjybaPzUrfqU0IMU5I0AswKMH7k8OTLs0vvV4KZpExkTkY87nR/zpbuTPj+gARop7aGUbl11pnDfW6xg=="], - - "mdn-data": ["mdn-data@2.27.1", "", {}, "sha512-9Yubnt3e8A0OKwxYSXyhLymGW4sCufcLG6VdiDdUGVkPhpqLxlvP5vl1983gQjJl3tqbrM731mjaZaP68AgosQ=="], - - "meow": ["meow@13.2.0", "", {}, "sha512-pxQJQzB6djGPXh08dacEloMFopsOqGVRKFPYvPOt9XDZ1HasbgDZA74CJGreSU4G3Ak7EFJGoiH2auq+yXISgA=="], - - "merge-stream": ["merge-stream@2.0.0", "", {}, "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w=="], - - "merge2": ["merge2@1.4.1", "", {}, "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg=="], - - "micromatch": ["micromatch@4.0.8", "", { "dependencies": { "braces": "^3.0.3", "picomatch": "^2.3.1" } }, "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA=="], - - "mime-db": ["mime-db@1.54.0", "", {}, "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ=="], - - "mimic-fn": ["mimic-fn@2.1.0", "", {}, "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg=="], - - "mimic-response": ["mimic-response@4.0.0", "", {}, "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg=="], - - "minimatch": ["minimatch@9.0.9", "", { "dependencies": { "brace-expansion": "^2.0.2" } }, "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg=="], - - "minimist": ["minimist@1.2.8", "", {}, "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA=="], - - "ms": ["ms@2.1.3", "", {}, "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="], - - "nanoid": ["nanoid@3.3.11", "", { "bin": { "nanoid": "bin/nanoid.cjs" } }, "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w=="], - - "natural-compare": ["natural-compare@1.4.0", "", {}, "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw=="], - - "natural-orderby": ["natural-orderby@5.0.0", "", {}, "sha512-kKHJhxwpR/Okycz4HhQKKlhWe4ASEfPgkSWNmKFHd7+ezuQlxkA5cM3+XkBPvm1gmHen3w53qsYAv+8GwRrBlg=="], - - "node-addon-api": ["node-addon-api@7.1.1", "", {}, "sha512-5m3bsyrjFWE1xf7nz7YXdN4udnVtXK6/Yfgn5qnahL6bCkf2yKt4k3nuTKAtT4r3IG8JNR2ncsIMdZuAzJjHQQ=="], - - "node-releases": ["node-releases@2.0.38", "", {}, "sha512-3qT/88Y3FbH/Kx4szpQQ4HzUbVrHPKTLVpVocKiLfoYvw9XSGOX2FmD2d6DrXbVYyAQTF2HeF6My8jmzx7/CRw=="], - - "normalize-path": ["normalize-path@3.0.0", "", {}, "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA=="], - - "normalize-url": ["normalize-url@8.1.1", "", {}, "sha512-JYc0DPlpGWB40kH5g07gGTrYuMqV653k3uBKY6uITPWds3M0ov3GaWGp9lbE3Bzngx8+XkfzgvASb9vk9JDFXQ=="], - - "npm-run-path": ["npm-run-path@4.0.1", "", { "dependencies": { "path-key": "^3.0.0" } }, "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw=="], - - "onetime": ["onetime@5.1.2", "", { "dependencies": { "mimic-fn": "^2.1.0" } }, "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg=="], - - "optics-ts": ["optics-ts@2.4.1", "", {}, "sha512-HaYzMHvC80r7U/LqAd4hQyopDezC60PO2qF5GuIwALut2cl5rK1VWHsqTp0oqoJJWjiv6uXKqsO+Q2OO0C3MmQ=="], - - "optionator": ["optionator@0.9.4", "", { "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", "type-check": "^0.4.0", "word-wrap": "^1.2.5" } }, "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g=="], - - "oxc-resolver": ["oxc-resolver@11.19.1", "", { "optionalDependencies": { "@oxc-resolver/binding-android-arm-eabi": "11.19.1", "@oxc-resolver/binding-android-arm64": "11.19.1", "@oxc-resolver/binding-darwin-arm64": "11.19.1", "@oxc-resolver/binding-darwin-x64": "11.19.1", "@oxc-resolver/binding-freebsd-x64": "11.19.1", "@oxc-resolver/binding-linux-arm-gnueabihf": "11.19.1", "@oxc-resolver/binding-linux-arm-musleabihf": "11.19.1", "@oxc-resolver/binding-linux-arm64-gnu": "11.19.1", "@oxc-resolver/binding-linux-arm64-musl": "11.19.1", "@oxc-resolver/binding-linux-ppc64-gnu": "11.19.1", "@oxc-resolver/binding-linux-riscv64-gnu": "11.19.1", "@oxc-resolver/binding-linux-riscv64-musl": "11.19.1", "@oxc-resolver/binding-linux-s390x-gnu": "11.19.1", "@oxc-resolver/binding-linux-x64-gnu": "11.19.1", "@oxc-resolver/binding-linux-x64-musl": "11.19.1", "@oxc-resolver/binding-openharmony-arm64": "11.19.1", "@oxc-resolver/binding-wasm32-wasi": "11.19.1", "@oxc-resolver/binding-win32-arm64-msvc": "11.19.1", "@oxc-resolver/binding-win32-ia32-msvc": "11.19.1", "@oxc-resolver/binding-win32-x64-msvc": "11.19.1" } }, "sha512-qE/CIg/spwrTBFt5aKmwe3ifeDdLfA2NESN30E42X/lII5ClF8V7Wt6WIJhcGZjp0/Q+nQ+9vgxGk//xZNX2hg=="], - - "oxlint": ["oxlint@1.61.0", "", { "optionalDependencies": { "@oxlint/binding-android-arm-eabi": "1.61.0", "@oxlint/binding-android-arm64": "1.61.0", "@oxlint/binding-darwin-arm64": "1.61.0", "@oxlint/binding-darwin-x64": "1.61.0", "@oxlint/binding-freebsd-x64": "1.61.0", "@oxlint/binding-linux-arm-gnueabihf": "1.61.0", "@oxlint/binding-linux-arm-musleabihf": "1.61.0", "@oxlint/binding-linux-arm64-gnu": "1.61.0", "@oxlint/binding-linux-arm64-musl": "1.61.0", "@oxlint/binding-linux-ppc64-gnu": "1.61.0", "@oxlint/binding-linux-riscv64-gnu": "1.61.0", "@oxlint/binding-linux-riscv64-musl": "1.61.0", "@oxlint/binding-linux-s390x-gnu": "1.61.0", "@oxlint/binding-linux-x64-gnu": "1.61.0", "@oxlint/binding-linux-x64-musl": "1.61.0", "@oxlint/binding-openharmony-arm64": "1.61.0", "@oxlint/binding-win32-arm64-msvc": "1.61.0", "@oxlint/binding-win32-ia32-msvc": "1.61.0", "@oxlint/binding-win32-x64-msvc": "1.61.0" }, "peerDependencies": { "oxlint-tsgolint": ">=0.18.0" }, "optionalPeers": ["oxlint-tsgolint"], "bin": { "oxlint": "bin/oxlint" } }, "sha512-ZC0ALuhDZ6ivOFG+sy0D0pEDN49EvsId98zVlmYdkcXHsEM14m/qTNUEsUpiFiCVbpIxYtVBmmLE87nsbUHohQ=="], - - "p-cancelable": ["p-cancelable@3.0.0", "", {}, "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw=="], - - "p-limit": ["p-limit@3.1.0", "", { "dependencies": { "yocto-queue": "^0.1.0" } }, "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ=="], - - "p-locate": ["p-locate@5.0.0", "", { "dependencies": { "p-limit": "^3.0.2" } }, "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw=="], - - "parent-module": ["parent-module@1.0.1", "", { "dependencies": { "callsites": "^3.0.0" } }, "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g=="], - - "parse-json": ["parse-json@5.2.0", "", { "dependencies": { "@babel/code-frame": "^7.0.0", "error-ex": "^1.3.1", "json-parse-even-better-errors": "^2.3.0", "lines-and-columns": "^1.1.6" } }, "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg=="], - - "path-exists": ["path-exists@4.0.0", "", {}, "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w=="], - - "path-key": ["path-key@3.1.1", "", {}, "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q=="], - - "path-parse": ["path-parse@1.0.7", "", {}, "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="], - - "path-type": ["path-type@4.0.0", "", {}, "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw=="], - - "pend": ["pend@1.2.0", "", {}, "sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg=="], - - "picocolors": ["picocolors@1.1.1", "", {}, "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA=="], - - "picomatch": ["picomatch@4.0.4", "", {}, "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A=="], - - "piscina": ["piscina@4.9.2", "", { "optionalDependencies": { "@napi-rs/nice": "^1.0.1" } }, "sha512-Fq0FERJWFEUpB4eSY59wSNwXD4RYqR+nR/WiEVcZW8IWfVBxJJafcgTEZDQo8k3w0sUarJ8RyVbbUF4GQ2LGbQ=="], - - "playwright": ["playwright@1.59.1", "", { "dependencies": { "playwright-core": "1.59.1" }, "optionalDependencies": { "fsevents": "2.3.2" }, "bin": { "playwright": "cli.js" } }, "sha512-C8oWjPR3F81yljW9o5OxcWzfh6avkVwDD2VYdwIGqTkl+OGFISgypqzfu7dOe4QNLL2aqcWBmI3PMtLIK233lw=="], - - "playwright-core": ["playwright-core@1.59.1", "", { "bin": { "playwright-core": "cli.js" } }, "sha512-HBV/RJg81z5BiiZ9yPzIiClYV/QMsDCKUyogwH9p3MCP6IYjUFu/MActgYAvK0oWyV9NlwM3GLBjADyWgydVyg=="], - - "postcss": ["postcss@8.5.12", "", { "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" } }, "sha512-W62t/Se6rA0Az3DfCL0AqJwXuKwBeYg6nOaIgzP+xZ7N5BFCI7DYi1qs6ygUYT6rvfi6t9k65UMLJC+PHZpDAA=="], - - "postcss-media-query-parser": ["postcss-media-query-parser@0.2.3", "", {}, "sha512-3sOlxmbKcSHMjlUXQZKQ06jOswE7oVkXPxmZdoB1r5l0q6gTFTQSHxNxOrCccElbW7dxNytifNEo8qidX2Vsig=="], - - "postcss-resolve-nested-selector": ["postcss-resolve-nested-selector@0.1.6", "", {}, "sha512-0sglIs9Wmkzbr8lQwEyIzlDOOC9bGmfVKcJTaxv3vMmd3uo4o4DerC3En0bnmgceeql9BfC8hRkp7cg0fjdVqw=="], - - "postcss-safe-parser": ["postcss-safe-parser@7.0.1", "", { "peerDependencies": { "postcss": "^8.4.31" } }, "sha512-0AioNCJZ2DPYz5ABT6bddIqlhgwhpHZ/l65YAYo0BCIn0xiDpsnTHz0gnoTGk0OXZW0JRs+cDwL8u/teRdz+8A=="], - - "postcss-scss": ["postcss-scss@4.0.9", "", { "peerDependencies": { "postcss": "^8.4.29" } }, "sha512-AjKOeiwAitL/MXxQW2DliT28EKukvvbEWx3LBmJIRN8KfBGZbRTxNYW0kSqi1COiTZ57nZ9NW06S6ux//N1c9A=="], - - "postcss-selector-parser": ["postcss-selector-parser@7.1.1", "", { "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" } }, "sha512-orRsuYpJVw8LdAwqqLykBj9ecS5/cRHlI5+nvTo8LcCKmzDmqVORXtOIYEEQuL9D4BxtA1lm5isAqzQZCoQ6Eg=="], - - "postcss-sorting": ["postcss-sorting@10.0.0", "", { "peerDependencies": { "postcss": "^8.4.20" } }, "sha512-TXbU+h6vVRW+86c/+ewhWq9k7pr7ijASTnepVhCQiC87zAOTkvB1v2dHyWP+ggstSTX/PNvjzS+IOqzejndz9w=="], - - "postcss-value-parser": ["postcss-value-parser@4.2.0", "", {}, "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ=="], - - "prelude-ls": ["prelude-ls@1.2.1", "", {}, "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g=="], - - "prettier": ["prettier@4.0.0-alpha.13", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-177K/2S5iYDKtvZkDC2ZMqpyXtoiiVQBVQZpcQsRs+ZIIUQxsXomWIjquAlwt2pXpio9riz5IgtaUEnoZH44tg=="], - - "prettier-plugin-pkg": ["prettier-plugin-pkg@0.21.2", "", { "peerDependencies": { "prettier": "^3.0.3" } }, "sha512-CSlM5+51B7yTKcoRWT4M3ImcdFHD5NUz0Xu2t8J03B761zu6J3BjSo/XleKp2kB0tH49K7oG5Uuqn6ldI5LRLg=="], - - "prettier-plugin-sh": ["prettier-plugin-sh@0.18.1", "", { "dependencies": { "@reteps/dockerfmt": "^0.5.1", "sh-syntax": "^0.5.8" }, "peerDependencies": { "prettier": "^3.6.0" } }, "sha512-uZmU22wBMevjh3rmCatNQqiEer2+5KLa0xYCBX6zQQUQkcNzVL+s6FbPKK6ZSUNUbQk6jMAcQHrYPvuL2W6ihQ=="], - - "punycode": ["punycode@2.3.1", "", {}, "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg=="], - - "pure-rand": ["pure-rand@6.1.0", "", {}, "sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA=="], - - "purify-ts": ["purify-ts@2.1.2", "", { "dependencies": { "@types/json-schema": "7.0.15" } }, "sha512-v9RnHfoxZJZt5PeZork6zErRwYnGKxUiO7wk+NqPnJcG7AKjt97ut41WbGRMSUuMBexrXZsVNePSMcO9qPHODQ=="], - - "qified": ["qified@0.9.1", "", { "dependencies": { "hookified": "^2.1.1" } }, "sha512-n7mar4T0xQ+39dE2vGTAlbxUEpndwPANH0kDef1/MYsB8Bba9wshkybIRx74qgcvKQPEWErf9AqAdYjhzY2Ilg=="], - - "queue-microtask": ["queue-microtask@1.2.3", "", {}, "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A=="], - - "quick-lru": ["quick-lru@5.1.1", "", {}, "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA=="], - - "readdirp": ["readdirp@4.1.2", "", {}, "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg=="], - - "regenerate": ["regenerate@1.4.2", "", {}, "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A=="], - - "regenerate-unicode-properties": ["regenerate-unicode-properties@10.2.2", "", { "dependencies": { "regenerate": "^1.4.2" } }, "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g=="], - - "regenerator-runtime": ["regenerator-runtime@0.14.1", "", {}, "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw=="], - - "regexp-to-ast": ["regexp-to-ast@0.5.0", "", {}, "sha512-tlbJqcMHnPKI9zSrystikWKwHkBqu2a/Sgw01h3zFjvYrMxEDYHzzoMZnUrbIfpTFEsoRnnviOXNCzFiSc54Qw=="], - - "regexpu-core": ["regexpu-core@6.4.0", "", { "dependencies": { "regenerate": "^1.4.2", "regenerate-unicode-properties": "^10.2.2", "regjsgen": "^0.8.0", "regjsparser": "^0.13.0", "unicode-match-property-ecmascript": "^2.0.0", "unicode-match-property-value-ecmascript": "^2.2.1" } }, "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA=="], - - "regjsgen": ["regjsgen@0.8.0", "", {}, "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q=="], - - "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=="], - - "resolve": ["resolve@1.22.12", "", { "dependencies": { "es-errors": "^1.3.0", "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, "bin": { "resolve": "bin/resolve" } }, "sha512-TyeJ1zif53BPfHootBGwPRYT1RUt6oGWsaQr8UyZW/eAm9bKoijtvruSDEmZHm92CwS9nj7/fWttqPCgzep8CA=="], - - "resolve-alpn": ["resolve-alpn@1.2.1", "", {}, "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g=="], - - "resolve-from": ["resolve-from@5.0.0", "", {}, "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw=="], - - "responselike": ["responselike@3.0.0", "", { "dependencies": { "lowercase-keys": "^3.0.0" } }, "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg=="], - - "reusify": ["reusify@1.1.0", "", {}, "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw=="], - - "rollup": ["rollup@4.60.2", "", { "dependencies": { "@types/estree": "1.0.8" }, "optionalDependencies": { "@rollup/rollup-android-arm-eabi": "4.60.2", "@rollup/rollup-android-arm64": "4.60.2", "@rollup/rollup-darwin-arm64": "4.60.2", "@rollup/rollup-darwin-x64": "4.60.2", "@rollup/rollup-freebsd-arm64": "4.60.2", "@rollup/rollup-freebsd-x64": "4.60.2", "@rollup/rollup-linux-arm-gnueabihf": "4.60.2", "@rollup/rollup-linux-arm-musleabihf": "4.60.2", "@rollup/rollup-linux-arm64-gnu": "4.60.2", "@rollup/rollup-linux-arm64-musl": "4.60.2", "@rollup/rollup-linux-loong64-gnu": "4.60.2", "@rollup/rollup-linux-loong64-musl": "4.60.2", "@rollup/rollup-linux-ppc64-gnu": "4.60.2", "@rollup/rollup-linux-ppc64-musl": "4.60.2", "@rollup/rollup-linux-riscv64-gnu": "4.60.2", "@rollup/rollup-linux-riscv64-musl": "4.60.2", "@rollup/rollup-linux-s390x-gnu": "4.60.2", "@rollup/rollup-linux-x64-gnu": "4.60.2", "@rollup/rollup-linux-x64-musl": "4.60.2", "@rollup/rollup-openbsd-x64": "4.60.2", "@rollup/rollup-openharmony-arm64": "4.60.2", "@rollup/rollup-win32-arm64-msvc": "4.60.2", "@rollup/rollup-win32-ia32-msvc": "4.60.2", "@rollup/rollup-win32-x64-gnu": "4.60.2", "@rollup/rollup-win32-x64-msvc": "4.60.2", "fsevents": "~2.3.2" }, "bin": { "rollup": "dist/bin/rollup" } }, "sha512-J9qZyW++QK/09NyN/zeO0dG/1GdGfyp9lV8ajHnRVLfo/uFsbji5mHnDgn/qYdUHyCkM2N+8VyspgZclfAh0eQ=="], - - "run-parallel": ["run-parallel@1.2.0", "", { "dependencies": { "queue-microtask": "^1.2.2" } }, "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA=="], - - "rxjs": ["rxjs@7.8.2", "", { "dependencies": { "tslib": "^2.1.0" } }, "sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA=="], - - "safe-buffer": ["safe-buffer@5.2.1", "", {}, "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ=="], - - "sass": ["sass@1.99.0", "", { "dependencies": { "chokidar": "^4.0.0", "immutable": "^5.1.5", "source-map-js": ">=0.6.2 <2.0.0" }, "optionalDependencies": { "@parcel/watcher": "^2.4.1" }, "bin": { "sass": "sass.js" } }, "sha512-kgW13M54DUB7IsIRM5LvJkNlpH+WhMpooUcaWGFARkF1Tc82v9mIWkCbCYf+MBvpIUBSeSOTilpZjEPr2VYE6Q=="], - - "sass-embedded": ["sass-embedded@1.99.0", "", { "dependencies": { "@bufbuild/protobuf": "^2.5.0", "colorjs.io": "^0.5.0", "immutable": "^5.1.5", "rxjs": "^7.4.0", "supports-color": "^8.1.1", "sync-child-process": "^1.0.2", "varint": "^6.0.0" }, "optionalDependencies": { "sass-embedded-all-unknown": "1.99.0", "sass-embedded-android-arm": "1.99.0", "sass-embedded-android-arm64": "1.99.0", "sass-embedded-android-riscv64": "1.99.0", "sass-embedded-android-x64": "1.99.0", "sass-embedded-darwin-arm64": "1.99.0", "sass-embedded-darwin-x64": "1.99.0", "sass-embedded-linux-arm": "1.99.0", "sass-embedded-linux-arm64": "1.99.0", "sass-embedded-linux-musl-arm": "1.99.0", "sass-embedded-linux-musl-arm64": "1.99.0", "sass-embedded-linux-musl-riscv64": "1.99.0", "sass-embedded-linux-musl-x64": "1.99.0", "sass-embedded-linux-riscv64": "1.99.0", "sass-embedded-linux-x64": "1.99.0", "sass-embedded-unknown-all": "1.99.0", "sass-embedded-win32-arm64": "1.99.0", "sass-embedded-win32-x64": "1.99.0" }, "bin": { "sass": "dist/bin/sass.js" } }, "sha512-gF/juR1aX02lZHkvwxdF80SapkQeg2fetoDF6gIQkNbSw5YEUFspMkyGTjPjgZSgIHuZpy+Wz4PlebKnLXMjdg=="], - - "sass-embedded-all-unknown": ["sass-embedded-all-unknown@1.99.0", "", { "dependencies": { "sass": "1.99.0" }, "cpu": [ "!arm", "!x64", "!arm64", ] }, "sha512-qPIRG8Uhjo6/OKyAKixTnwMliTz+t9K6Duk0mx5z+K7n0Ts38NSJz2sjDnc7cA/8V9Lb3q09H38dZ1CLwD+ssw=="], - - "sass-embedded-android-arm": ["sass-embedded-android-arm@1.99.0", "", { "os": "android", "cpu": "arm" }, "sha512-EHvJ0C7/VuP78Qr6f8gIUVUmCqIorEQpw2yp3cs3SMg02ZuumlhjXvkTcFBxHmFdFR23vTNk1WnhY6QSeV1nFQ=="], - - "sass-embedded-android-arm64": ["sass-embedded-android-arm64@1.99.0", "", { "os": "android", "cpu": "arm64" }, "sha512-fNHhdnP23yqqieCbAdym4N47AleSwjbNt6OYIYx4DdACGdtERjQB4iOX/TaKsW034MupfF7SjnAAK8w7Ptldtg=="], - - "sass-embedded-android-riscv64": ["sass-embedded-android-riscv64@1.99.0", "", { "os": "android", "cpu": "none" }, "sha512-4zqDFRvgGDTL5vTHuIhRxUpXFoh0Cy7Gm5Ywk19ASd8Settmd14YdPRZPmMxfgS1GH292PofV1fq1ifiSEJWBw=="], - - "sass-embedded-android-x64": ["sass-embedded-android-x64@1.99.0", "", { "os": "android", "cpu": "x64" }, "sha512-Uk53k/dGYt04RjOL4gFjZ0Z9DH9DKh8IA8WsXUkNqsxerAygoy3zqRBS2zngfE9K2jiOM87q+1R1p87ory9oQQ=="], - - "sass-embedded-darwin-arm64": ["sass-embedded-darwin-arm64@1.99.0", "", { "os": "darwin", "cpu": "arm64" }, "sha512-u61/7U3IGLqoO6gL+AHeiAtlTPFwJK1+964U8gp45ZN0hzh1yrARf5O1mivXv8NnNgJvbG2wWJbiNZP0lG/lTg=="], - - "sass-embedded-darwin-x64": ["sass-embedded-darwin-x64@1.99.0", "", { "os": "darwin", "cpu": "x64" }, "sha512-j/kkk/NcXdIameLezSfXjgCiBkVcA+G60AXrX768/3g0miK1g7M9dj7xOhCb1i7/wQeiEI3rw2LLuO63xRIn4A=="], - - "sass-embedded-linux-arm": ["sass-embedded-linux-arm@1.99.0", "", { "os": "linux", "cpu": "arm" }, "sha512-d4IjJZrX2+AwB2YCy1JySwdptJECNP/WfAQLUl8txI3ka8/d3TUI155GtelnoZUkio211PwIeFvvAeZ9RXPQnw=="], - - "sass-embedded-linux-arm64": ["sass-embedded-linux-arm64@1.99.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-btNcFpItcB56L40n8hDeL7sRSMLDXQ56nB5h2deddJx1n60rpKSElJmkaDGHtpkrY+CTtDRV0FZDjHeTJddYew=="], - - "sass-embedded-linux-musl-arm": ["sass-embedded-linux-musl-arm@1.99.0", "", { "os": "linux", "cpu": "arm" }, "sha512-2gvHOupgIw3ytatXT4nFUow71LFbuOZPEwG+HUzcNQDH8ue4Ez8cr03vsv5MDv3lIjOKcXwDvWD980t18MwkoQ=="], - - "sass-embedded-linux-musl-arm64": ["sass-embedded-linux-musl-arm64@1.99.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-Hi2bt/IrM5P4FBKz6EcHAlniwfpoz9mnTdvSd58y+avA3SANM76upIkAdSayA8ZGwyL3gZokru1AKDPF9lJDNw=="], - - "sass-embedded-linux-musl-riscv64": ["sass-embedded-linux-musl-riscv64@1.99.0", "", { "os": "linux", "cpu": "none" }, "sha512-mKqGvVaJ9rHMqyZsF0kikQe4NO0f4osb67+X6nLhBiVDKvyazQHJ3zJQreNefIE36yL2sjHIclSB//MprzaQDg=="], - - "sass-embedded-linux-musl-x64": ["sass-embedded-linux-musl-x64@1.99.0", "", { "os": "linux", "cpu": "x64" }, "sha512-huhgOMmOc30r7CH7qbRbT9LerSEGSnWuS4CYNOskr9BvNeQp4dIneFufNRGZ7hkOAxUM8DglxIZJN/cyAT95Ew=="], - - "sass-embedded-linux-riscv64": ["sass-embedded-linux-riscv64@1.99.0", "", { "os": "linux", "cpu": "none" }, "sha512-mevFPIFAVhrH90THifxLfOntFmHtcEKOcdWnep2gJ0X4DVva4AiVIRlQe/7w9JFx5+gnDRE1oaJJkzuFUuYZsA=="], - - "sass-embedded-linux-x64": ["sass-embedded-linux-x64@1.99.0", "", { "os": "linux", "cpu": "x64" }, "sha512-9k7IkULqIZdCIVt4Mboryt6vN8Mjmm3EhI1P3mClU5y5i3wLK5ExC3cbVWk047KsID/fvB1RLslqghXJx5BoxA=="], - - "sass-embedded-unknown-all": ["sass-embedded-unknown-all@1.99.0", "", { "dependencies": { "sass": "1.99.0" }, "os": [ "!linux", "!win32", "!darwin", "!android", ] }, "sha512-P7MxiUtL/XzGo3PX0CaB8lNNEFLQWKikPA8pbKytx9ZCLZSDkt2NJcdAbblB/sqMs4AV3EK2NadV8rI/diq3xg=="], - - "sass-embedded-win32-arm64": ["sass-embedded-win32-arm64@1.99.0", "", { "os": "win32", "cpu": "arm64" }, "sha512-8whpsW7S+uO8QApKfQuc36m3P9EISzbVZOgC79goob4qGy09u8Gz/rYvw8h1prJDSjltpHGhOzBE6LDz7WvzVw=="], - - "sass-embedded-win32-x64": ["sass-embedded-win32-x64@1.99.0", "", { "os": "win32", "cpu": "x64" }, "sha512-ipuOv1R2K4MHeuCEAZGpuUbAgma4gb0sdacyrTjJtMOy/OY9UvWfVlwErdB09KIkp4fPDpQJDJfvYN6bC8jeNg=="], - - "seek-bzip": ["seek-bzip@2.0.0", "", { "dependencies": { "commander": "^6.0.0" }, "bin": { "seek-bunzip": "bin/seek-bunzip", "seek-table": "bin/seek-bzip-table" } }, "sha512-SMguiTnYrhpLdk3PwfzHeotrcwi8bNV4iemL9tx9poR/yeaMYwB9VzR1w7b57DuWpuqR8n6oZboi0hj3AxZxQg=="], - - "semver": ["semver@7.7.4", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA=="], - - "semver-regex": ["semver-regex@4.0.5", "", {}, "sha512-hunMQrEy1T6Jr2uEVjrAIqjwWcQTgOAcIM52C8MY1EZSD3DDNft04XzvYKPqjED65bNVVko0YI38nYeEHCX3yw=="], - - "semver-truncate": ["semver-truncate@3.0.0", "", { "dependencies": { "semver": "^7.3.5" } }, "sha512-LJWA9kSvMolR51oDE6PN3kALBNaUdkxzAGcexw8gjMA8xr5zUqK0JiR3CgARSqanYF3Z1YHvsErb1KDgh+v7Rg=="], - - "sh-syntax": ["sh-syntax@0.5.8", "", { "dependencies": { "tslib": "^2.8.1" } }, "sha512-JfVoxf4FxQI5qpsPbkHhZo+n6N9YMJobyl4oGEUBb/31oQYlgTjkXQD8PBiafS2UbWoxrTO0Z5PJUBXEPAG1Zw=="], - - "shebang-command": ["shebang-command@2.0.0", "", { "dependencies": { "shebang-regex": "^3.0.0" } }, "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA=="], - - "shebang-regex": ["shebang-regex@3.0.0", "", {}, "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A=="], - - "signal-exit": ["signal-exit@4.1.0", "", {}, "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw=="], - - "slash": ["slash@3.0.0", "", {}, "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q=="], - - "slice-ansi": ["slice-ansi@4.0.0", "", { "dependencies": { "ansi-styles": "^4.0.0", "astral-regex": "^2.0.0", "is-fullwidth-code-point": "^3.0.0" } }, "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ=="], - - "smol-toml": ["smol-toml@1.6.1", "", {}, "sha512-dWUG8F5sIIARXih1DTaQAX4SsiTXhInKf1buxdY9DIg4ZYPZK5nGM1VRIYmEbDbsHt7USo99xSLFu5Q1IqTmsg=="], - - "sort-keys": ["sort-keys@1.1.2", "", { "dependencies": { "is-plain-obj": "^1.0.0" } }, "sha512-vzn8aSqKgytVik0iwdBEi+zevbTYZogewTUM6dtpmGwEcdzbub/TX4bCzRhebDCRC3QzXgJsLRKB2V/Oof7HXg=="], - - "sort-keys-length": ["sort-keys-length@1.0.1", "", { "dependencies": { "sort-keys": "^1.0.0" } }, "sha512-GRbEOUqCxemTAk/b32F2xa8wDTs+Z1QHOkbhJDQTvv/6G3ZkbJ+frYWsTcc7cBB3Fu4wy4XlLCuNtJuMn7Gsvw=="], - - "source-map": ["source-map@0.7.6", "", {}, "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ=="], - - "source-map-js": ["source-map-js@1.2.1", "", {}, "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA=="], - - "source-map-support": ["source-map-support@0.5.21", "", { "dependencies": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" } }, "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w=="], - - "streamx": ["streamx@2.25.0", "", { "dependencies": { "events-universal": "^1.0.0", "fast-fifo": "^1.3.2", "text-decoder": "^1.1.0" } }, "sha512-0nQuG6jf1w+wddNEEXCF4nTg3LtufWINB5eFEN+5TNZW7KWJp6x87+JFL43vaAUPyCfH1wID+mNVyW6OHtFamg=="], - - "string-width": ["string-width@4.2.3", "", { "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", "strip-ansi": "^6.0.1" } }, "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g=="], - - "strip-ansi": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="], - - "strip-dirs": ["strip-dirs@3.0.0", "", { "dependencies": { "inspect-with-kind": "^1.0.5", "is-plain-obj": "^1.1.0" } }, "sha512-I0sdgcFTfKQlUPZyAqPJmSG3HLO9rWDFnxonnIbskYNM3DwFOeTNB5KzVq3dA1GdRAc/25b5Y7UO2TQfKWw4aQ=="], - - "strip-final-newline": ["strip-final-newline@2.0.0", "", {}, "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA=="], - - "strip-json-comments": ["strip-json-comments@5.0.3", "", {}, "sha512-1tB5mhVo7U+ETBKNf92xT4hrQa3pm0MZ0PQvuDnWgAAGHDsfp4lPSpiS6psrSiet87wyGPh9ft6wmhOMQ0hDiw=="], - - "strtok3": ["strtok3@10.3.5", "", { "dependencies": { "@tokenizer/token": "^0.3.0" } }, "sha512-ki4hZQfh5rX0QDLLkOCj+h+CVNkqmp/CMf8v8kZpkNVK6jGQooMytqzLZYUVYIZcFZ6yDB70EfD8POcFXiF5oA=="], - - "style-search": ["style-search@0.1.0", "", {}, "sha512-Dj1Okke1C3uKKwQcetra4jSuk0DqbzbYtXipzFlFMZtowbF1x7BKJwB9AayVMyFARvU8EDrZdcax4At/452cAg=="], - - "stylelint": ["stylelint@16.26.1", "", { "dependencies": { "@csstools/css-parser-algorithms": "^3.0.5", "@csstools/css-syntax-patches-for-csstree": "^1.0.19", "@csstools/css-tokenizer": "^3.0.4", "@csstools/media-query-list-parser": "^4.0.3", "@csstools/selector-specificity": "^5.0.0", "@dual-bundle/import-meta-resolve": "^4.2.1", "balanced-match": "^2.0.0", "colord": "^2.9.3", "cosmiconfig": "^9.0.0", "css-functions-list": "^3.2.3", "css-tree": "^3.1.0", "debug": "^4.4.3", "fast-glob": "^3.3.3", "fastest-levenshtein": "^1.0.16", "file-entry-cache": "^11.1.1", "global-modules": "^2.0.0", "globby": "^11.1.0", "globjoin": "^0.1.4", "html-tags": "^3.3.1", "ignore": "^7.0.5", "imurmurhash": "^0.1.4", "is-plain-object": "^5.0.0", "known-css-properties": "^0.37.0", "mathml-tag-names": "^2.1.3", "meow": "^13.2.0", "micromatch": "^4.0.8", "normalize-path": "^3.0.0", "picocolors": "^1.1.1", "postcss": "^8.5.6", "postcss-resolve-nested-selector": "^0.1.6", "postcss-safe-parser": "^7.0.1", "postcss-selector-parser": "^7.1.0", "postcss-value-parser": "^4.2.0", "resolve-from": "^5.0.0", "string-width": "^4.2.3", "supports-hyperlinks": "^3.2.0", "svg-tags": "^1.0.0", "table": "^6.9.0", "write-file-atomic": "^5.0.1" }, "bin": { "stylelint": "bin/stylelint.mjs" } }, "sha512-v20V59/crfc8sVTAtge0mdafI3AdnzQ2KsWe6v523L4OA1bJO02S7MO2oyXDCS6iWb9ckIPnqAFVItqSBQr7jw=="], - - "stylelint-config-clean-order": ["stylelint-config-clean-order@8.0.1", "", { "peerDependencies": { "stylelint": ">=16", "stylelint-order": ">=6" } }, "sha512-zKjp7BiINXRZOG9m0fE/6UKoM6clPekL+LoAiHMCiQU2hgirKL5G0mKc5Z0ygIhQXfb1+DTRDM0mu6Ecdv4q8g=="], - - "stylelint-config-recommended": ["stylelint-config-recommended@17.0.0", "", { "peerDependencies": { "stylelint": "^16.23.0" } }, "sha512-WaMSdEiPfZTSFVoYmJbxorJfA610O0tlYuU2aEwY33UQhSPgFbClrVJYWvy3jGJx+XW37O+LyNLiZOEXhKhJmA=="], - - "stylelint-config-recommended-scss": ["stylelint-config-recommended-scss@16.0.2", "", { "dependencies": { "postcss-scss": "^4.0.9", "stylelint-config-recommended": "^17.0.0", "stylelint-scss": "^6.12.1" }, "peerDependencies": { "postcss": "^8.3.3", "stylelint": "^16.24.0" }, "optionalPeers": ["postcss"] }, "sha512-aUTHhPPWCvFyWaxtckJlCPaXTDFsp4pKO8evXNCsW9OwsaUWyMd6jvcUhSmfGWPrTddvzNqK4rS/UuSLcbVGdQ=="], - - "stylelint-config-sass-guidelines": ["stylelint-config-sass-guidelines@12.1.0", "", { "dependencies": { "@stylistic/stylelint-plugin": "^3.0.1", "postcss-scss": "^4.0.9", "stylelint-scss": "^6.2.1" }, "peerDependencies": { "postcss": "^8.4.21", "stylelint": "^16.1.0" } }, "sha512-NTxEtVT6uNSqRvq+A3ScyKhjUrY/Z845TnpWEwnMgIPZ/+/Waa4+51r6OPuQRMu4XZS3D8DK1UaT4TWFBvuuAw=="], - - "stylelint-config-standard": ["stylelint-config-standard@39.0.1", "", { "dependencies": { "stylelint-config-recommended": "^17.0.0" }, "peerDependencies": { "stylelint": "^16.23.0" } }, "sha512-b7Fja59EYHRNOTa3aXiuWnhUWXFU2Nfg6h61bLfAb5GS5fX3LMUD0U5t4S8N/4tpHQg3Acs2UVPR9jy2l1g/3A=="], - - "stylelint-config-standard-scss": ["stylelint-config-standard-scss@16.0.0", "", { "dependencies": { "stylelint-config-recommended-scss": "^16.0.1", "stylelint-config-standard": "^39.0.0" }, "peerDependencies": { "postcss": "^8.3.3", "stylelint": "^16.23.1" }, "optionalPeers": ["postcss"] }, "sha512-/FHECLUu+med/e6OaPFpprG86ShC4SYT7Tzb2PTVdDjJsehhFBOioSlWqYFqJxmGPIwO3AMBxNo+kY3dxrbczA=="], - - "stylelint-declaration-block-no-ignored-properties": ["stylelint-declaration-block-no-ignored-properties@2.8.0", "", { "peerDependencies": { "stylelint": "^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0" } }, "sha512-Ws8Cav7Y+SPN0JsV407LrnNXWOrqGjxShf+37GBtnU/C58Syve9c0+I/xpLcFOosST3ternykn3Lp77f3ITnFw=="], - - "stylelint-order": ["stylelint-order@8.1.1", "", { "dependencies": { "postcss": "^8.5.8", "postcss-sorting": "^10.0.0" }, "peerDependencies": { "stylelint": "^16.18.0 || ^17.0.0" } }, "sha512-LqsEB6VggJuu5v10RtkrQsBObcdwBE7GuAOlwfc/LR3VL/w8UqKX2BOLIjhyGt0Gne/njo7gRNGiJAKhfmPMNw=="], - - "stylelint-plugin-logical-css": ["stylelint-plugin-logical-css@1.3.0", "", { "peerDependencies": { "stylelint": "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0" } }, "sha512-NDtuA+9tplPZTaA42vHFcldJGHiK5UFOIGIDP3ghTdWvo0pVI3NJlsOwMHoYs+XlvkRgRyzGrVVngddreebkTw=="], - - "stylelint-scss": ["stylelint-scss@6.14.0", "", { "dependencies": { "css-tree": "^3.0.1", "is-plain-object": "^5.0.0", "known-css-properties": "^0.37.0", "mdn-data": "^2.25.0", "postcss-media-query-parser": "^0.2.3", "postcss-resolve-nested-selector": "^0.1.6", "postcss-selector-parser": "^7.1.1", "postcss-value-parser": "^4.2.0" }, "peerDependencies": { "stylelint": "^16.8.2" } }, "sha512-ZKmHMZolxeuYsnB+PCYrTpFce0/QWX9i9gh0hPXzp73WjuIMqUpzdQaBCrKoLWh6XtCFSaNDErkMPqdjy1/8aA=="], - - "supports-color": ["supports-color@8.1.1", "", { "dependencies": { "has-flag": "^4.0.0" } }, "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q=="], - - "supports-hyperlinks": ["supports-hyperlinks@3.2.0", "", { "dependencies": { "has-flag": "^4.0.0", "supports-color": "^7.0.0" } }, "sha512-zFObLMyZeEwzAoKCyu1B91U79K2t7ApXuQfo8OuxwXLDgcKxuwM+YvcbIhm6QWqz7mHUH1TVytR1PwVVjEuMig=="], - - "supports-preserve-symlinks-flag": ["supports-preserve-symlinks-flag@1.0.0", "", {}, "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w=="], - - "svg-tags": ["svg-tags@1.0.0", "", {}, "sha512-ovssysQTa+luh7A5Weu3Rta6FJlFBBbInjOh722LIt6klpU2/HtdUbszju/G4devcvk8PGt7FCLv5wftu3THUA=="], - - "sync-child-process": ["sync-child-process@1.0.2", "", { "dependencies": { "sync-message-port": "^1.0.0" } }, "sha512-8lD+t2KrrScJ/7KXCSyfhT3/hRq78rC0wBFqNJXv3mZyn6hW2ypM05JmlSvtqRbeq6jqA94oHbxAr2vYsJ8vDA=="], - - "sync-message-port": ["sync-message-port@1.2.0", "", {}, "sha512-gAQ9qrUN/UCypHtGFbbe7Rc/f9bzO88IwrG8TDo/aMKAApKyD6E3W4Cm0EfhfBb6Z6SKt59tTCTfD+n1xmAvMg=="], - - "systemjs": ["systemjs@6.15.1", "", {}, "sha512-Nk8c4lXvMB98MtbmjX7JwJRgJOL8fluecYCfCeYBznwmpOs8Bf15hLM6z4z71EDAhQVrQrI+wt1aLWSXZq+hXA=="], - - "table": ["table@6.9.0", "", { "dependencies": { "ajv": "^8.0.1", "lodash.truncate": "^4.4.2", "slice-ansi": "^4.0.0", "string-width": "^4.2.3", "strip-ansi": "^6.0.1" } }, "sha512-9kY+CygyYM6j02t5YFHbNz2FN5QmYGv9zAjVp4lCDjlCw7amdckXlEt/bjMhUIfj4ThGRE4gCUH5+yGnNuPo5A=="], - - "tar-stream": ["tar-stream@3.1.8", "", { "dependencies": { "b4a": "^1.6.4", "bare-fs": "^4.5.5", "fast-fifo": "^1.2.0", "streamx": "^2.15.0" } }, "sha512-U6QpVRyCGHva435KoNWy9PRoi2IFYCgtEhq9nmrPPpbRacPs9IH4aJ3gbrFC8dPcXvdSZ4XXfXT5Fshbp2MtlQ=="], - - "teex": ["teex@1.0.1", "", { "dependencies": { "streamx": "^2.12.5" } }, "sha512-eYE6iEI62Ni1H8oIa7KlDU6uQBtqr4Eajni3wX7rpfXD8ysFx8z0+dri+KWEPWpBsxXfxu58x/0jvTVT1ekOSg=="], - - "terser": ["terser@5.46.2", "", { "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-uxfo9fPcSgLDYob/w1FuL0c99MWiJDnv+5qXSQc5+Ki5NjVNsYi66INnMFBjf6uFz6OnX12piJQPF4IpjJTNTw=="], - - "text-decoder": ["text-decoder@1.2.7", "", { "dependencies": { "b4a": "^1.6.4" } }, "sha512-vlLytXkeP4xvEq2otHeJfSQIRyWxo/oZGEbXrtEEF9Hnmrdly59sUbzZ/QgyWuLYHctCHxFF4tRQZNQ9k60ExQ=="], - - "through": ["through@2.3.8", "", {}, "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg=="], - - "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=="], - - "token-types": ["token-types@6.1.2", "", { "dependencies": { "@borewit/text-codec": "^0.2.1", "@tokenizer/token": "^0.3.0", "ieee754": "^1.2.1" } }, "sha512-dRXchy+C0IgK8WPC6xvCHFRIWYUbqqdEIKPaKo/AcTUNzwLTK6AH7RjdLWsEZcAN/TBdtfUw3PYEgPr5VPr6ww=="], - - "ts-api-utils": ["ts-api-utils@2.5.0", "", { "peerDependencies": { "typescript": ">=4.8.4" } }, "sha512-OJ/ibxhPlqrMM0UiNHJ/0CKQkoKF243/AEmplt3qpRgkW8VG7IfOS41h7V8TjITqdByHzrjcS/2si+y4lIh8NA=="], - - "ts-pattern": ["ts-pattern@5.9.0", "", {}, "sha512-6s5V71mX8qBUmlgbrfL33xDUwO0fq48rxAu2LBE11WBeGdpCPOsXksQbZJHvHwhrd3QjUusd3mAOM5Gg0mFBLg=="], - - "tsconfck": ["tsconfck@3.1.6", "", { "peerDependencies": { "typescript": "^5.0.0" }, "optionalPeers": ["typescript"], "bin": { "tsconfck": "bin/tsconfck.js" } }, "sha512-ks6Vjr/jEw0P1gmOVwutM3B7fWxoWBL2KRDb1JfqGVawBmO5UsvmWOQFGHBPl5yxYz4eERr19E6L7NMv+Fej4w=="], - - "tslib": ["tslib@2.8.1", "", {}, "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w=="], - - "type-check": ["type-check@0.4.0", "", { "dependencies": { "prelude-ls": "^1.2.1" } }, "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew=="], - - "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="], - - "typescript-eslint": ["typescript-eslint@8.59.0", "", { "dependencies": { "@typescript-eslint/eslint-plugin": "8.59.0", "@typescript-eslint/parser": "8.59.0", "@typescript-eslint/typescript-estree": "8.59.0", "@typescript-eslint/utils": "8.59.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "sha512-BU3ONW9X+v90EcCH9ZS6LMackcVtxRLlI3XrYyqZIwVSHIk7Qf7bFw1z0M9Q0IUxhTMZCf8piY9hTYaNEIASrw=="], - - "uint8array-extras": ["uint8array-extras@1.5.0", "", {}, "sha512-rvKSBiC5zqCCiDZ9kAOszZcDvdAHwwIKJG33Ykj43OKcWsnmcBRL09YTU4nOeHZ8Y2a7l1MgTd08SBe9A8Qj6A=="], - - "unbash": ["unbash@2.2.0", "", {}, "sha512-X2wH19RAPZE3+ldGicOkoj/SIA83OIxcJ6Cuaw23hf8Xc6fQpvZXY0SftE2JgS0QhYLUG4uwodSI3R53keyh7w=="], - - "unbzip2-stream": ["unbzip2-stream@1.4.3", "", { "dependencies": { "buffer": "^5.2.1", "through": "^2.3.8" } }, "sha512-mlExGW4w71ebDJviH16lQLtZS32VKqsSfk80GCfUlwT/4/hNRFsoscrF/c++9xinkMzECL1uL9DDwXqFWkruPg=="], - - "undici-types": ["undici-types@7.16.0", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="], - - "unicode-canonical-property-names-ecmascript": ["unicode-canonical-property-names-ecmascript@2.0.1", "", {}, "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg=="], - - "unicode-match-property-ecmascript": ["unicode-match-property-ecmascript@2.0.0", "", { "dependencies": { "unicode-canonical-property-names-ecmascript": "^2.0.0", "unicode-property-aliases-ecmascript": "^2.0.0" } }, "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q=="], - - "unicode-match-property-value-ecmascript": ["unicode-match-property-value-ecmascript@2.2.1", "", {}, "sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg=="], - - "unicode-property-aliases-ecmascript": ["unicode-property-aliases-ecmascript@2.2.0", "", {}, "sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ=="], - - "update-browserslist-db": ["update-browserslist-db@1.2.3", "", { "dependencies": { "escalade": "^3.2.0", "picocolors": "^1.1.1" }, "peerDependencies": { "browserslist": ">= 4.21.0" }, "bin": { "update-browserslist-db": "cli.js" } }, "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w=="], - - "uri-js": ["uri-js@4.4.1", "", { "dependencies": { "punycode": "^2.1.0" } }, "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg=="], - - "util-deprecate": ["util-deprecate@1.0.2", "", {}, "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw=="], - - "valibot": ["valibot@1.1.0", "", { "peerDependencies": { "typescript": ">=5" }, "optionalPeers": ["typescript"] }, "sha512-Nk8lX30Qhu+9txPYTwM0cFlWLdPFsFr6LblzqIySfbZph9+BFsAHsNvHOymEviUepeIW6KFHzpX8TKhbptBXXw=="], - - "varint": ["varint@6.0.0", "", {}, "sha512-cXEIW6cfr15lFv563k4GuVuW/fiwjknytD37jIOLSdSWuOI6WnO/oKwmP2FQTU2l01LP8/M5TSAJpzUaGe3uWg=="], - - "vite": ["vite@7.3.2", "", { "dependencies": { "esbuild": "^0.27.0", "fdir": "^6.5.0", "picomatch": "^4.0.3", "postcss": "^8.5.6", "rollup": "^4.43.0", "tinyglobby": "^0.2.15" }, "optionalDependencies": { "fsevents": "~2.3.3" }, "peerDependencies": { "@types/node": "^20.19.0 || >=22.12.0", "jiti": ">=1.21.0", "less": "^4.0.0", "lightningcss": "^1.21.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", "jiti", "less", "lightningcss", "sass", "sass-embedded", "stylus", "sugarss", "terser", "tsx", "yaml"], "bin": { "vite": "bin/vite.js" } }, "sha512-Bby3NOsna2jsjfLVOHKes8sGwgl4TT0E6vvpYgnAYDIF/tie7MRaFthmKuHx1NSXjiTueXH3do80FMQgvEktRg=="], - - "vite-plugin-valibot-env": ["vite-plugin-valibot-env@1.0.2", "", { "dependencies": { "is-unicode-supported": "^2.1.0" }, "peerDependencies": { "valibot": ">=1.0.0", "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0" } }, "sha512-jw8XbdvJtYMTVVDVY4kXM+VWsUMYYPTknGDIzf5E2VMVyyA6KDPPg9xr0pd+bIrpov8fF5saMset6xP8jbnMQQ=="], - - "vite-tsconfig-paths": ["vite-tsconfig-paths@5.1.4", "", { "dependencies": { "debug": "^4.1.1", "globrex": "^0.1.2", "tsconfck": "^3.0.3" }, "peerDependencies": { "vite": "*" }, "optionalPeers": ["vite"] }, "sha512-cYj0LRuLV2c2sMqhqhGpaO3LretdtMn/BVX4cPLanIZuwwrkVl+lK84E/miEXkCHWXuq65rhNN4rXsBcOB3S4w=="], - - "walk-up-path": ["walk-up-path@4.0.0", "", {}, "sha512-3hu+tD8YzSLGuFYtPRb48vdhKMi0KQV5sn+uWr8+7dMEq/2G/dtLrdDinkLjqq5TIbIBjYJ4Ax/n3YiaW7QM8A=="], - - "which": ["which@2.0.2", "", { "dependencies": { "isexe": "^2.0.0" }, "bin": { "node-which": "./bin/node-which" } }, "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA=="], - - "word-wrap": ["word-wrap@1.2.5", "", {}, "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA=="], - - "wp-types": ["wp-types@4.69.0", "", { "dependencies": { "typescript": ">=4" } }, "sha512-2w0i2ygylpbYpqFskg1NlvH/1DM8thZuhxjihFRHdvjgFkmzJ2cHl2kq9cBnxYWHyLHzRiLI2TupKbq3yl2STQ=="], - - "write-file-atomic": ["write-file-atomic@5.0.1", "", { "dependencies": { "imurmurhash": "^0.1.4", "signal-exit": "^4.0.1" } }, "sha512-+QU2zd6OTD8XWIJCbffaiQeH9U73qIqafo1x6V1snCWYGJf6cVE0cDR4D8xRzcEnfI21IFrUPzPGtcPf8AC+Rw=="], - - "yallist": ["yallist@3.1.1", "", {}, "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g=="], - - "yaml": ["yaml@2.8.3", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg=="], - - "yauzl": ["yauzl@3.3.0", "", { "dependencies": { "buffer-crc32": "~0.2.3", "pend": "~1.2.0" } }, "sha512-PtGEvEP30p7sbIBJKUBjUnqgTVOyMURc4dLo9iNyAJnNIEz9pm88cCXF21w94Kg3k6RXkeZh5DHOGS0qEONvNQ=="], - - "yocto-queue": ["yocto-queue@0.1.0", "", {}, "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="], - - "zod": ["zod@4.3.6", "", {}, "sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg=="], - - "@babel/core/semver": ["semver@6.3.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA=="], - - "@babel/helper-compilation-targets/semver": ["semver@6.3.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA=="], - - "@babel/helper-create-class-features-plugin/semver": ["semver@6.3.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA=="], - - "@babel/helper-create-regexp-features-plugin/semver": ["semver@6.3.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA=="], - - "@babel/preset-env/babel-plugin-polyfill-corejs3": ["babel-plugin-polyfill-corejs3@0.14.2", "", { "dependencies": { "@babel/helper-define-polyfill-provider": "^0.6.8", "core-js-compat": "^3.48.0" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "sha512-coWpDLJ410R781Npmn/SIBZEsAetR4xVi0SxLMXPaMO4lSf1MwnkGYMtkFxew0Dn8B3/CpbpYxN0JCgg8mn67g=="], - - "@babel/preset-env/semver": ["semver@6.3.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA=="], - - "@cacheable/memory/keyv": ["keyv@5.6.0", "", { "dependencies": { "@keyv/serialize": "^1.1.1" } }, "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw=="], - - "@cacheable/utils/keyv": ["keyv@5.6.0", "", { "dependencies": { "@keyv/serialize": "^1.1.1" } }, "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw=="], - - "@eslint-community/eslint-utils/eslint-visitor-keys": ["eslint-visitor-keys@3.4.3", "", {}, "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag=="], - - "@eslint/config-array/minimatch": ["minimatch@3.1.5", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w=="], - - "@eslint/eslintrc/globals": ["globals@14.0.0", "", {}, "sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ=="], - - "@eslint/eslintrc/minimatch": ["minimatch@3.1.5", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w=="], - - "@eslint/eslintrc/strip-json-comments": ["strip-json-comments@3.1.1", "", {}, "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig=="], - - "@keyv/bigmap/keyv": ["keyv@5.6.0", "", { "dependencies": { "@keyv/serialize": "^1.1.1" } }, "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw=="], - - "@stylistic/stylelint-plugin/@csstools/media-query-list-parser": ["@csstools/media-query-list-parser@3.0.1", "", { "peerDependencies": { "@csstools/css-parser-algorithms": "^3.0.1", "@csstools/css-tokenizer": "^3.0.1" } }, "sha512-HNo8gGD02kHmcbX6PvCoUuOQvn4szyB9ca63vZHKX5A81QytgDG4oxG4IaEfHTlEZSZ6MjPEMWIVU+zF2PZcgw=="], - - "@stylistic/stylelint-plugin/postcss-selector-parser": ["postcss-selector-parser@6.1.2", "", { "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" } }, "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg=="], - - "@typescript-eslint/eslint-plugin/ignore": ["ignore@7.0.5", "", {}, "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg=="], - - "@typescript-eslint/typescript-estree/minimatch": ["minimatch@10.2.5", "", { "dependencies": { "brace-expansion": "^5.0.5" } }, "sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg=="], - - "@typescript-eslint/visitor-keys/eslint-visitor-keys": ["eslint-visitor-keys@5.0.1", "", {}, "sha512-tD40eHxA35h0PEIZNeIjkHoDR4YjjJp34biM0mDvplBe//mB+IHCqHDGV7pxF+7MklTvighcCPPZC7ynWyjdTA=="], - - "babel-plugin-polyfill-corejs2/semver": ["semver@6.3.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA=="], - - "brace-expansion/balanced-match": ["balanced-match@1.0.2", "", {}, "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="], - - "cacheable/keyv": ["keyv@5.6.0", "", { "dependencies": { "@keyv/serialize": "^1.1.1" } }, "sha512-CYDD3SOtsHtyXeEORYRx2qBtpDJFjRTGXUtmNEMGyzYOKj1TE3tycdlho7kA1Ufx9OYWZzg52QFBGALTirzDSw=="], - - "decompress-response/mimic-response": ["mimic-response@3.1.0", "", {}, "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ=="], - - "eslint/chalk": ["chalk@4.1.2", "", { "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" } }, "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA=="], - - "eslint/minimatch": ["minimatch@3.1.5", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w=="], - - "execa/signal-exit": ["signal-exit@3.0.7", "", {}, "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ=="], - - "fast-glob/glob-parent": ["glob-parent@5.1.2", "", { "dependencies": { "is-glob": "^4.0.1" } }, "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow=="], - - "global-prefix/which": ["which@1.3.1", "", { "dependencies": { "isexe": "^2.0.0" }, "bin": { "which": "./bin/which" } }, "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ=="], - - "import-fresh/resolve-from": ["resolve-from@4.0.0", "", {}, "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g=="], - - "micromatch/picomatch": ["picomatch@2.3.2", "", {}, "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA=="], - - "qified/hookified": ["hookified@2.2.0", "", {}, "sha512-p/LgFzRN5FeoD3DLS6bkUapeye6E4SI6yJs6KetENd18S+FBthqYq2amJUWpt5z0EQwwHemidjY5OqJGEKm5uA=="], - - "rollup/fsevents": ["fsevents@2.3.3", "", { "os": "darwin" }, "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw=="], - - "seek-bzip/commander": ["commander@6.2.1", "", {}, "sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA=="], - - "source-map-support/source-map": ["source-map@0.6.1", "", {}, "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g=="], - - "stylelint/file-entry-cache": ["file-entry-cache@11.1.2", "", { "dependencies": { "flat-cache": "^6.1.20" } }, "sha512-N2WFfK12gmrK1c1GXOqiAJ1tc5YE+R53zvQ+t5P8S5XhnmKYVB5eZEiLNZKDSmoG8wqqbF9EXYBBW/nef19log=="], - - "stylelint/ignore": ["ignore@7.0.5", "", {}, "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg=="], - - "stylelint-scss/mdn-data": ["mdn-data@2.28.0", "", {}, "sha512-uy9AS1yt+wW5eUEefgE3lOpqPghanUttycV0GXKbiXyBjwvbeE8XPj4u1C+voRfz7dEjwU4NDHTMfZ/s/JtZrQ=="], - - "supports-hyperlinks/supports-color": ["supports-color@7.2.0", "", { "dependencies": { "has-flag": "^4.0.0" } }, "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw=="], - - "table/ajv": ["ajv@8.20.0", "", { "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2" } }, "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA=="], - - "terser/commander": ["commander@2.20.3", "", {}, "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ=="], - - "vite/fsevents": ["fsevents@2.3.3", "", { "os": "darwin" }, "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw=="], - - "@eslint/config-array/minimatch/brace-expansion": ["brace-expansion@1.1.14", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g=="], - - "@eslint/eslintrc/minimatch/brace-expansion": ["brace-expansion@1.1.14", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g=="], - - "@typescript-eslint/typescript-estree/minimatch/brace-expansion": ["brace-expansion@5.0.5", "", { "dependencies": { "balanced-match": "^4.0.2" } }, "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ=="], - - "eslint/chalk/supports-color": ["supports-color@7.2.0", "", { "dependencies": { "has-flag": "^4.0.0" } }, "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw=="], - - "eslint/minimatch/brace-expansion": ["brace-expansion@1.1.14", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g=="], - - "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=="], - - "table/ajv/json-schema-traverse": ["json-schema-traverse@1.0.0", "", {}, "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="], - - "@eslint/config-array/minimatch/brace-expansion/balanced-match": ["balanced-match@1.0.2", "", {}, "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="], - - "@eslint/eslintrc/minimatch/brace-expansion/balanced-match": ["balanced-match@1.0.2", "", {}, "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="], - - "@typescript-eslint/typescript-estree/minimatch/brace-expansion/balanced-match": ["balanced-match@4.0.4", "", {}, "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA=="], - - "eslint/minimatch/brace-expansion/balanced-match": ["balanced-match@1.0.2", "", {}, "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="], - } -} diff --git a/cfg/eslint.config.ts b/cfg/eslint.config.ts new file mode 100755 index 00000000..5d3630f4 --- /dev/null +++ b/cfg/eslint.config.ts @@ -0,0 +1,16 @@ +import type { Config } from "eslint/config"; + +import { configTypescriptNavigateur } from "@gcch/configuration-eslint"; +import { defineConfig } from "eslint/config"; + +const esLintConfig: ReadonlyArray = defineConfig( + { + ignores: [".cache", "web/app/plugins", "**/*.js"], + }, + [...configTypescriptNavigateur], + { + files: ["*.ts", "web/app/themes/haiku-atelier-2024/src/**/*.ts"], + }, +); + +export default esLintConfig; diff --git a/cfg/oxlint.config.ts b/cfg/oxlint.config.ts new file mode 100644 index 00000000..814cf38c --- /dev/null +++ b/cfg/oxlint.config.ts @@ -0,0 +1,13 @@ +import gcchConfig from "@gcch/configuration-oxlint"; +import type { OxlintConfig } from "oxlint"; + +const config: OxlintConfig = { + ...gcchConfig, + // Désactive la configuration liée à Astro. + overrides: [], + globals: { + Bun: "readonly", + }, +}; + +export default config; diff --git a/cfg/playwright.config.ts b/cfg/playwright.config.ts new file mode 100644 index 00000000..1087f3a3 --- /dev/null +++ b/cfg/playwright.config.ts @@ -0,0 +1,50 @@ +import { defineConfig, devices, PlaywrightTestConfig } from "@playwright/test"; + +const playwrightConfig: PlaywrightTestConfig = defineConfig({ + fullyParallel: true, + projects: [ + { + name: "desktop-chromium-1920", + use: { ...devices["Desktop Chrome"], viewport: { height: 1080, width: 1920 } }, + }, + { + name: "desktop-firefox-1920", + use: { ...devices["Desktop Firefox"], viewport: { height: 1080, width: 1920 } }, + }, + // { + // name: "tablet-chromium-portrait", + // use: { ...devices["Galaxy Tab S9"] }, + // }, + // { + // name: "tablet-chromium-landscape", + // use: { ...devices["Galaxy Tab S9 landscape"] }, + // }, + // { + // name: "mobile-chromium-portrait", + // use: { ...devices["Pixel 7"] }, + // }, + // { + // name: "mobile-chromium-landscape", + // use: { ...devices["Pixel 7 landscape"] }, + // }, + ], + reporter: "list", + retries: 1, + testDir: "../tests", + timeout: 10_000, + use: { + baseURL: "https://haikuatelier.gcch.local", + clientCertificates: [ + { + origin: "https://haikuatelier.gcch.local", + certPath: "../containers/data/certs/_wildcard.gcch.local.pem", + keyPath: "../containers/data/certs/_wildcard.gcch.local-key.pem", + }, + ], + ignoreHTTPSErrors: true, + trace: "retry-with-trace", + }, + workers: "50%", +}); + +export default playwrightConfig; diff --git a/cfg/prettier.config.ts b/cfg/prettier.config.ts new file mode 100755 index 00000000..cadfe8c3 --- /dev/null +++ b/cfg/prettier.config.ts @@ -0,0 +1,7 @@ +import { configClassique } from "@gcch/configuration-prettier"; + +const config = { + ...configClassique, +}; + +export default config; diff --git a/cfg/prettierignore b/cfg/prettierignore new file mode 100755 index 00000000..a2c7e7e7 --- /dev/null +++ b/cfg/prettierignore @@ -0,0 +1,39 @@ +# Tout ce qui est traité par treefmt +*.css +*.html +*.js +*.json +*.md +*.mjs +*.mts +*.php +*.scss +*.sh +*.ts +*.xml +*.yaml +*.yml +!package.json + +# Cache +.cache + +# Tout sauf le thème +**/vendor +**/web/app/languages +**/web/app/mu-plugins +**/web/app/plugins +**/web/app/themes/haiku-atelier-2024/assets +**/web/app/themes/twentytwentyfour +**/web/app/uploads +**/web/wp + +# Dépendances +composer.lock +bun.lock + +# Jujutsu +.jj/ + +# Zed +.zed/ diff --git a/cfg/stylelint.config.ts b/cfg/stylelint.config.ts new file mode 100755 index 00000000..b8719537 --- /dev/null +++ b/cfg/stylelint.config.ts @@ -0,0 +1,63 @@ +import { Array as FxArray, pipe } from "effect"; +import type stylelint from "stylelint"; +import { propertyGroups } from "stylelint-config-clean-order"; + +/** + * Définition d'un groupe de Propriétés _CSS_ du plugin `stylelint-config-clean-order` pour _Stylelint_. + */ +type StylelintConfigCleanOrderPropertyGroup = { + emptyLineBefore: "never" | "threshold"; + noEmptyLineBetween: boolean; + properties: ReadonlyArray | string; +}; + +const ordreProprietes: ReadonlyArray = pipe( + Array.from(propertyGroups), + FxArray.map((properties: ReadonlyArray) => ({ + emptyLineBefore: "never", + noEmptyLineBetween: true, + properties, + })), +); + +const stylelintConfig: stylelint.Config = { + extends: ["stylelint-config-standard-scss", "stylelint-config-sass-guidelines", "stylelint-config-clean-order"], + plugins: ["stylelint-declaration-block-no-ignored-properties"], + rules: { + "@stylistic/function-parentheses-space-inside": undefined, + "@stylistic/selector-list-comma-newline-after": undefined, + "@stylistic/string-quotes": undefined, + "alpha-value-notation": ["percentage"], + "color-function-notation": "modern", + "color-no-hex": true, + "custom-property-pattern": undefined, + "declaration-block-no-duplicate-custom-properties": true, + "declaration-block-no-duplicate-properties": true, + "declaration-block-no-redundant-longhand-properties": true, + "declaration-block-no-shorthand-property-overrides": true, + "function-disallowed-list": ["rgba", "hsla", "rgb", "hsl"], + "max-nesting-depth": undefined, + "no-descending-specificity": undefined, + "no-duplicate-selectors": [ + true, + { + disallowInList: false, + }, + ], + "order/properties-order": [ + ordreProprietes, + { + severity: "error", + unspecified: "bottomAlphabetical", + }, + ], + "plugin/declaration-block-no-ignored-properties": true, + "selector-class-pattern": undefined, + "selector-id-pattern": undefined, + "selector-max-compound-selectors": undefined, + "selector-max-id": undefined, + "selector-no-qualifying-type": undefined, + }, +}; + +export default stylelintConfig; diff --git a/vite.config.ts b/cfg/vite.config.ts similarity index 69% rename from vite.config.ts rename to cfg/vite.config.ts index cc08e920..5e049c19 100755 --- a/vite.config.ts +++ b/cfg/vite.config.ts @@ -1,8 +1,7 @@ -import { fdir, PathsOutput } from "fdir"; +import type { PathsOutput } from "fdir"; +import { fdir } from "fdir"; import process from "node:process"; -import * as v from "valibot"; import { defineConfig, loadEnv } from "vite"; -import valibot from "vite-plugin-valibot-env"; const SLUG_THEME = "haiku-atelier-2024"; const SRC_TYPESCRIPT_PATHS: Promise = new fdir() @@ -13,21 +12,8 @@ const SRC_TYPESCRIPT_PATHS: Promise = new fdir() .withPromise(); const PATHS = await SRC_TYPESCRIPT_PATHS; -// Voir le fichier vite.env.d.ts. -const SCHEMA_ENVIRONNEMENT = v.object({ - VITE_GLITCHTIP_NSD: v.pipe(v.string(), v.url(), v.readonly()), - VITE_MODE: v.pipe(v.string(), v.readonly()), - VITE_URL: v.pipe(v.string(), v.nonEmpty(), v.url(), v.readonly()), -}); - -const basePlugins = [ - // Permet de valider les variables d'environnements définies à partir d'un schéma Valibot - valibot(SCHEMA_ENVIRONNEMENT), -]; - export default defineConfig(({ mode }) => { const env = loadEnv(mode, process.cwd(), "VITE"); - console.debug(env); return { base: "/", @@ -53,11 +39,11 @@ export default defineConfig(({ mode }) => { target: "es2020", write: true, }, + cacheDir: ".cache/vite", css: { devSourcemap: true, transformer: "lightningcss", }, mode: env["VITE_MODE"] ?? "production", - plugins: [...basePlugins], }; }); diff --git a/compose.yaml b/compose.yaml index 384bad4c..a5e148b3 100755 --- a/compose.yaml +++ b/compose.yaml @@ -25,33 +25,6 @@ services: restart: "unless-stopped" volumes: - "db-data:/var/lib/mysql:rw" - jaeger: - container_name: "haikuatelier.fr-jaeger" - environment: - - "COLLECTOR_OTLP_ENABLED=true" - healthcheck: - interval: "5s" - retries: 3 - start_period: "5s" - test: - - "CMD" - - "wget" - - "--spider" - - "http://localhost:16686" - timeout: "2s" - image: "cr.jaegertracing.io/jaegertracing/jaeger:latest" - networks: - - "haiku-network" - ports: - - "6831:6831/udp" - - "6832:6832/udp" - - "5778:5778" - - "16686:16686" - - "4317:4317" - - "4318:4318" - - "14250:14250" - - "14268:14268" - - "14269:14269" proxy: container_name: "haikuatelier.fr-proxy" depends_on: @@ -72,6 +45,7 @@ services: restart: "on-failure:3" volumes: - "./containers/conf/angie:/etc/angie:rw" + # - "./containers/conf/angie-2:/etc/angie:rw" - "./containers/data/certs:/etc/angie/ssl:ro" - "./containers/data/angie/logs:/var/log/angie:rw" - "./:/var/www/wordpress:rw" @@ -105,30 +79,10 @@ services: - "./containers/data/certs:/etc/certs/:ro" - "./containers/data/traefik/logs:/var/log/traefik:rw" - "/var/run/user/1000/podman/podman.sock:/var/run/docker.sock:ro" - valkey: - command: "valkey-server /usr/local/etc/valkey/valkey.conf" - container_name: "haikuatelier.fr-valkey" - env_file: - - path: "./.env" - required: true - healthcheck: - interval: "10s" - retries: 3 - test: - - "CMD-SHELL" - - "valkey-cli ping | grep PONG" - timeout: "5s" - image: "docker.io/valkey/valkey:9-alpine" - restart: "unless-stopped" - sysctls: - - "net.core.somaxconn=512" - volumes: - - "./containers/conf/valkey.conf:/usr/local/etc/valkey/valkey.conf:ro" wordpress: container_name: "haikuatelier.fr-wordpress" depends_on: - "db" - - "valkey" - "traefik" env_file: - path: "./.env" diff --git a/composer.json b/composer.json index 8ff1ce4f..76f33810 100755 --- a/composer.json +++ b/composer.json @@ -1,9 +1,11 @@ { - "autoload": { "psr-4": { "HaikuAtelier\\": "web/app/themes/haiku-atelier-2024/src/inc/" } }, - "authors": [ - { "email": "scott.walkinshaw@gmail.com", "homepage": "https://github.com/swalkinshaw", "name": "Scott Walkinshaw" }, - { "email": "ben@benword.com", "homepage": "https://github.com/retlehs", "name": "Ben Word" } - ], + "$schema": "https://getcomposer.org/schema.json", + "authors": [], + "autoload": { + "psr-4": { + "HaikuAtelier\\": "web/app/themes/haiku-atelier-2024/src/inc/" + } + }, "config": { "allow-plugins": { "carthage-software/mago": true, @@ -12,75 +14,83 @@ "phpstan/extension-installer": true, "roots/wordpress-core-installer": true }, + "classmap-authoritative": true, "optimize-autoloader": true, "preferred-install": "dist", "sort-packages": true }, - "description": "WordPress boilerplate with Composer, easier configuration, and an improved folder structure", + "description": "", "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"], - "license": "MIT", - "minimum-stability": "dev", - "name": "roots/bedrock", + "minimum-stability": "stable", + "name": "gcch/haiku-atelier", "prefer-stable": true, "repositories": [ - { "only": ["wpackagist-plugin/*", "wpackagist-theme/*"], "type": "composer", "url": "https://wpackagist.org" } + { + "only": [ + "wpackagist-plugin/*", + "wpackagist-theme/*" + ], + "type": "composer", + "url": "https://wpackagist.org" + } ], "require": { - "php": ">=8.5", - "azjezz/psl": "^4.2", "composer/installers": "^2.3", "crell/fp": "^1.0", - "htmlburger/carbon-fields": "^3.6", - "illuminate/support": "^12.43", - "laravel/helpers": "^1.7.1", + "htmlburger/carbon-fields": "^3.6.9", + "illuminate/support": "^13.4", + "laravel/helpers": "^1.8.3", "log1x/wp-smtp": "^1.0.2", - "lstrojny/functional-php": "^1.17", + "lstrojny/functional-php": "^1.18", "mnsami/composer-custom-directory-installer": "^2.0", - "nesbot/carbon": "^3.8.2", + "nesbot/carbon": "^3.11.4", "oscarotero/env": "^2.1.1", - "roots/bedrock-autoloader": "^1.0.4", - "roots/bedrock-disallow-indexing": "^2.0", - "roots/wordpress": "^6.8.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", "roots/wp-config": "^1.0", - "stripe/stripe-php": "^16.3", - "symfony/uid": "^8", - "timber/timber": "^2.3", - "vlucas/phpdotenv": "^5.6.1", - "wpackagist-plugin/falcon": "^2.8.4", - "wpackagist-plugin/force-regenerate-thumbnails": "^2.2.1", - "wpackagist-plugin/query-monitor": "^3.17.0", - "wpackagist-plugin/redis-cache": "^2.5.4", - "wpackagist-plugin/wc-multishipping": "^3.0", - "wpackagist-plugin/woo-preview-emails": "^2.2.13", - "wpackagist-plugin/woocommerce": "^10", - "wpackagist-plugin/wp-mail-logging": "^1.13.1", - "wpackagist-plugin/wp-mail-smtp": "^4.2", - "wpackagist-plugin/wp-openapi": "^1.0.16", - "wpackagist-theme/twentytwentyfour": "^1.3" + "stripe/stripe-php": "^19.4.1", + "symfony/uid": "^8.0.8", + "timber/timber": "^2.3.3", + "vlucas/phpdotenv": "^5.6.3", + "wpackagist-plugin/falcon": "^2.9.3", + "wpackagist-plugin/force-regenerate-thumbnails": "^2.3.0", + "wpackagist-plugin/query-monitor": "^4.0.5", + "wpackagist-plugin/redis-cache": "^2.7.0", + "wpackagist-plugin/wc-multishipping": "^3.0.2", + "wpackagist-plugin/woo-preview-emails": "^2.2.14", + "wpackagist-plugin/woocommerce": "^10.6.2", + "wpackagist-plugin/wp-mail-logging": "^1.16.0", + "wpackagist-plugin/wp-mail-smtp": "^4.7.1", + "wpackagist-plugin/wp-openapi": "^1.0.27", + "wpackagist-theme/twentytwentyfour": "^1.4" }, "require-dev": { - "friendsofphp/php-cs-fixer": "^3.89", - "php-standard-library/phpstan-extension": "^2.0", + "friendsofphp/php-cs-fixer": "^3.94.2", + "php-standard-library/phpstan-extension": "^2.1", "phpstan/extension-installer": "^1.4.3", - "phpstan/phpstan": "^2.0.3", - "rector/rector": "^2.2", + "phpstan/phpstan": "^2.1.46", "roave/security-advisories": "dev-latest", "szepeviktor/phpstan-wordpress": "2.x-dev", - "vincentlanglet/twig-cs-fixer": "^3.10" - }, - "support": { - "forum": "https://discourse.roots.io/category/bedrock", - "issues": "https://github.com/roots/bedrock/issues" + "vincentlanglet/twig-cs-fixer": "^3.14" }, "type": "project" } diff --git a/composer.lock b/composer.lock index 73f77a72..95cb4931 100644 --- a/composer.lock +++ b/composer.lock @@ -4,84 +4,8 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "656fefb6a4e896ee0c5f5d87f36db997", + "content-hash": "b81b62efbedadf3c57fb437e86ef6766", "packages": [ - { - "name": "azjezz/psl", - "version": "4.2.0", - "source": { - "type": "git", - "url": "https://github.com/azjezz/psl.git", - "reference": "15153a64c9824335ce11654522e7d88de762d39e" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/azjezz/psl/zipball/15153a64c9824335ce11654522e7d88de762d39e", - "reference": "15153a64c9824335ce11654522e7d88de762d39e", - "shasum": "" - }, - "require": { - "ext-bcmath": "*", - "ext-intl": "*", - "ext-json": "*", - "ext-mbstring": "*", - "ext-sodium": "*", - "php": "~8.3.0 || ~8.4.0 || ~8.5.0", - "revolt/event-loop": "^1.0.7" - }, - "require-dev": { - "carthage-software/mago": "^1.0.0-beta.32", - "infection/infection": "^0.31.2", - "php-coveralls/php-coveralls": "^2.7.0", - "phpbench/phpbench": "^1.4.0", - "phpunit/phpunit": "^9.6.22" - }, - "suggest": { - "php-standard-library/phpstan-extension": "PHPStan integration", - "php-standard-library/psalm-plugin": "Psalm integration" - }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/hhvm/hsl", - "name": "hhvm/hsl" - } - }, - "autoload": { - "files": [ - "src/bootstrap.php" - ], - "psr-4": { - "Psl\\": "src/Psl" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "azjezz", - "email": "azjezz@protonmail.com" - } - ], - "description": "PHP Standard Library", - "support": { - "issues": "https://github.com/azjezz/psl/issues", - "source": "https://github.com/azjezz/psl/tree/4.2.0" - }, - "funding": [ - { - "url": "https://github.com/azjezz", - "type": "github" - }, - { - "url": "https://github.com/veewee", - "type": "github" - } - ], - "time": "2025-10-25T08:31:40+00:00" - }, { "name": "carbonphp/carbon-doctrine-types", "version": "3.2.0", @@ -459,24 +383,24 @@ }, { "name": "graham-campbell/result-type", - "version": "v1.1.3", + "version": "v1.1.4", "source": { "type": "git", "url": "https://github.com/GrahamCampbell/Result-Type.git", - "reference": "3ba905c11371512af9d9bdd27d99b782216b6945" + "reference": "e01f4a821471308ba86aa202fed6698b6b695e3b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/GrahamCampbell/Result-Type/zipball/3ba905c11371512af9d9bdd27d99b782216b6945", - "reference": "3ba905c11371512af9d9bdd27d99b782216b6945", + "url": "https://api.github.com/repos/GrahamCampbell/Result-Type/zipball/e01f4a821471308ba86aa202fed6698b6b695e3b", + "reference": "e01f4a821471308ba86aa202fed6698b6b695e3b", "shasum": "" }, "require": { "php": "^7.2.5 || ^8.0", - "phpoption/phpoption": "^1.9.3" + "phpoption/phpoption": "^1.9.5" }, "require-dev": { - "phpunit/phpunit": "^8.5.39 || ^9.6.20 || ^10.5.28" + "phpunit/phpunit": "^8.5.41 || ^9.6.22 || ^10.5.45 || ^11.5.7" }, "type": "library", "autoload": { @@ -505,7 +429,7 @@ ], "support": { "issues": "https://github.com/GrahamCampbell/Result-Type/issues", - "source": "https://github.com/GrahamCampbell/Result-Type/tree/v1.1.3" + "source": "https://github.com/GrahamCampbell/Result-Type/tree/v1.1.4" }, "funding": [ { @@ -517,7 +441,7 @@ "type": "tidelift" } ], - "time": "2024-07-20T21:45:45+00:00" + "time": "2025-12-27T19:43:20+00:00" }, { "name": "htmlburger/carbon-fields", @@ -661,34 +585,34 @@ }, { "name": "illuminate/collections", - "version": "v12.43.1", + "version": "v13.7.0", "source": { "type": "git", "url": "https://github.com/illuminate/collections.git", - "reference": "16657effa6a5a4e728f9aeb3e38fb4fa9ba70e7d" + "reference": "36cfc25fc23ca18714fc8ee6abc947ee99c18462" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/illuminate/collections/zipball/16657effa6a5a4e728f9aeb3e38fb4fa9ba70e7d", - "reference": "16657effa6a5a4e728f9aeb3e38fb4fa9ba70e7d", + "url": "https://api.github.com/repos/illuminate/collections/zipball/36cfc25fc23ca18714fc8ee6abc947ee99c18462", + "reference": "36cfc25fc23ca18714fc8ee6abc947ee99c18462", "shasum": "" }, "require": { - "illuminate/conditionable": "^12.0", - "illuminate/contracts": "^12.0", - "illuminate/macroable": "^12.0", - "php": "^8.2", + "illuminate/conditionable": "^13.0", + "illuminate/contracts": "^13.0", + "illuminate/macroable": "^13.0", + "php": "^8.3", "symfony/polyfill-php84": "^1.33", "symfony/polyfill-php85": "^1.33" }, "suggest": { - "illuminate/http": "Required to convert collections to API resources (^12.0).", - "symfony/var-dumper": "Required to use the dump method (^7.2)." + "illuminate/http": "Required to convert collections to API resources (^13.0).", + "symfony/var-dumper": "Required to use the dump method (^7.4 || ^8.0)." }, "type": "library", "extra": { "branch-alias": { - "dev-master": "12.x-dev" + "dev-master": "13.0.x-dev" } }, "autoload": { @@ -716,29 +640,29 @@ "issues": "https://github.com/laravel/framework/issues", "source": "https://github.com/laravel/framework" }, - "time": "2025-12-06T18:08:25+00:00" + "time": "2026-04-27T18:16:57+00:00" }, { "name": "illuminate/conditionable", - "version": "v12.43.1", + "version": "v13.7.0", "source": { "type": "git", "url": "https://github.com/illuminate/conditionable.git", - "reference": "ec677967c1f2faf90b8428919124d2184a4c9b49" + "reference": "7f1ef52d9a346f829421b296adfb7644a951b216" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/illuminate/conditionable/zipball/ec677967c1f2faf90b8428919124d2184a4c9b49", - "reference": "ec677967c1f2faf90b8428919124d2184a4c9b49", + "url": "https://api.github.com/repos/illuminate/conditionable/zipball/7f1ef52d9a346f829421b296adfb7644a951b216", + "reference": "7f1ef52d9a346f829421b296adfb7644a951b216", "shasum": "" }, "require": { - "php": "^8.2" + "php": "^8.3" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "12.x-dev" + "dev-master": "13.0.x-dev" } }, "autoload": { @@ -762,31 +686,31 @@ "issues": "https://github.com/laravel/framework/issues", "source": "https://github.com/laravel/framework" }, - "time": "2025-05-13T15:08:45+00:00" + "time": "2026-02-25T16:07:55+00:00" }, { "name": "illuminate/contracts", - "version": "v12.43.1", + "version": "v13.7.0", "source": { "type": "git", "url": "https://github.com/illuminate/contracts.git", - "reference": "19e8938edb73047017cfbd443b96844b86da4a59" + "reference": "a5f08426a807faac42616f733113ba263779f2dd" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/illuminate/contracts/zipball/19e8938edb73047017cfbd443b96844b86da4a59", - "reference": "19e8938edb73047017cfbd443b96844b86da4a59", + "url": "https://api.github.com/repos/illuminate/contracts/zipball/a5f08426a807faac42616f733113ba263779f2dd", + "reference": "a5f08426a807faac42616f733113ba263779f2dd", "shasum": "" }, "require": { - "php": "^8.2", - "psr/container": "^1.1.1|^2.0.1", - "psr/simple-cache": "^1.0|^2.0|^3.0" + "php": "^8.3", + "psr/container": "^1.1.1 || ^2.0.1", + "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "12.x-dev" + "dev-master": "13.0.x-dev" } }, "autoload": { @@ -810,20 +734,20 @@ "issues": "https://github.com/laravel/framework/issues", "source": "https://github.com/laravel/framework" }, - "time": "2025-11-26T21:36:01+00:00" + "time": "2026-04-24T14:55:56+00:00" }, { "name": "illuminate/macroable", - "version": "v12.43.1", + "version": "v13.7.0", "source": { "type": "git", "url": "https://github.com/illuminate/macroable.git", - "reference": "e862e5648ee34004fa56046b746f490dfa86c613" + "reference": "f108cb3a8680f26e23c6ce7367c64525412d85b0" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/illuminate/macroable/zipball/e862e5648ee34004fa56046b746f490dfa86c613", - "reference": "e862e5648ee34004fa56046b746f490dfa86c613", + "url": "https://api.github.com/repos/illuminate/macroable/zipball/f108cb3a8680f26e23c6ce7367c64525412d85b0", + "reference": "f108cb3a8680f26e23c6ce7367c64525412d85b0", "shasum": "" }, "require": { @@ -832,7 +756,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "12.x-dev" + "dev-master": "13.0.x-dev" } }, "autoload": { @@ -856,31 +780,31 @@ "issues": "https://github.com/laravel/framework/issues", "source": "https://github.com/laravel/framework" }, - "time": "2024-07-23T16:31:01+00:00" + "time": "2026-03-28T19:16:13+00:00" }, { "name": "illuminate/reflection", - "version": "v12.43.1", + "version": "v13.7.0", "source": { "type": "git", "url": "https://github.com/illuminate/reflection.git", - "reference": "7b86bc570d5b75e4a3ad79f8cca1491ba24b7c75" + "reference": "4fe1659f068ab2b50131cf906c5d8bba4e34df0c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/illuminate/reflection/zipball/7b86bc570d5b75e4a3ad79f8cca1491ba24b7c75", - "reference": "7b86bc570d5b75e4a3ad79f8cca1491ba24b7c75", + "url": "https://api.github.com/repos/illuminate/reflection/zipball/4fe1659f068ab2b50131cf906c5d8bba4e34df0c", + "reference": "4fe1659f068ab2b50131cf906c5d8bba4e34df0c", "shasum": "" }, "require": { - "illuminate/collections": "^12.0", - "illuminate/contracts": "^12.0", - "php": "^8.2" + "illuminate/collections": "^13.0", + "illuminate/contracts": "^13.0", + "php": "^8.3" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "12.x-dev" + "dev-master": "13.0.x-dev" } }, "autoload": { @@ -907,20 +831,20 @@ "issues": "https://github.com/laravel/framework/issues", "source": "https://github.com/laravel/framework" }, - "time": "2025-12-09T15:11:22+00:00" + "time": "2026-03-10T20:04:12+00:00" }, { "name": "illuminate/support", - "version": "v12.43.1", + "version": "v13.7.0", "source": { "type": "git", "url": "https://github.com/illuminate/support.git", - "reference": "20014564c32e2e8c6a57e03d065bcf8706a458e7" + "reference": "cc0d9d484ddd83fa54a0495cf15e7606e6a6f4b1" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/illuminate/support/zipball/20014564c32e2e8c6a57e03d065bcf8706a458e7", - "reference": "20014564c32e2e8c6a57e03d065bcf8706a458e7", + "url": "https://api.github.com/repos/illuminate/support/zipball/cc0d9d484ddd83fa54a0495cf15e7606e6a6f4b1", + "reference": "cc0d9d484ddd83fa54a0495cf15e7606e6a6f4b1", "shasum": "" }, "require": { @@ -928,14 +852,13 @@ "ext-ctype": "*", "ext-filter": "*", "ext-mbstring": "*", - "illuminate/collections": "^12.0", - "illuminate/conditionable": "^12.0", - "illuminate/contracts": "^12.0", - "illuminate/macroable": "^12.0", - "illuminate/reflection": "^12.0", + "illuminate/collections": "^13.0", + "illuminate/conditionable": "^13.0", + "illuminate/contracts": "^13.0", + "illuminate/macroable": "^13.0", + "illuminate/reflection": "^13.0", "nesbot/carbon": "^3.8.4", - "php": "^8.2", - "symfony/polyfill-php83": "^1.33", + "php": "^8.3", "symfony/polyfill-php85": "^1.33", "voku/portable-ascii": "^2.0.2" }, @@ -946,20 +869,20 @@ "spatie/once": "*" }, "suggest": { - "illuminate/filesystem": "Required to use the Composer class (^12.0).", - "laravel/serializable-closure": "Required to use the once function (^1.3|^2.0).", + "illuminate/filesystem": "Required to use the Composer class (^13.0).", + "laravel/serializable-closure": "Required to use the once function (^2.0.10).", "league/commonmark": "Required to use Str::markdown() and Stringable::markdown() (^2.7).", "league/uri": "Required to use the Uri class (^7.5.1).", "ramsey/uuid": "Required to use Str::uuid() (^4.7).", - "symfony/process": "Required to use the Composer class (^7.2).", - "symfony/uid": "Required to use Str::ulid() (^7.2).", - "symfony/var-dumper": "Required to use the dd function (^7.2).", + "symfony/process": "Required to use the Composer class (^7.4 || ^8.0).", + "symfony/uid": "Required to use Str::ulid() (^7.4 || ^8.0).", + "symfony/var-dumper": "Required to use the dd function (^7.4 || ^8.0).", "vlucas/phpdotenv": "Required to use the Env class and env helper (^5.6.1)." }, "type": "library", "extra": { "branch-alias": { - "dev-master": "12.x-dev" + "dev-master": "13.0.x-dev" } }, "autoload": { @@ -987,24 +910,24 @@ "issues": "https://github.com/laravel/framework/issues", "source": "https://github.com/laravel/framework" }, - "time": "2025-12-14T15:58:12+00:00" + "time": "2026-04-27T13:46:05+00:00" }, { "name": "laravel/helpers", - "version": "v1.8.2", + "version": "v1.8.3", "source": { "type": "git", "url": "https://github.com/laravel/helpers.git", - "reference": "98499eea4c1cca76fb0fb37ed365a468773daf0a" + "reference": "5915be977c7cc05fe2498d561b8c026ee56567dd" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/laravel/helpers/zipball/98499eea4c1cca76fb0fb37ed365a468773daf0a", - "reference": "98499eea4c1cca76fb0fb37ed365a468773daf0a", + "url": "https://api.github.com/repos/laravel/helpers/zipball/5915be977c7cc05fe2498d561b8c026ee56567dd", + "reference": "5915be977c7cc05fe2498d561b8c026ee56567dd", "shasum": "" }, "require": { - "illuminate/support": "~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0", + "illuminate/support": "~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0|^13.0", "php": "^7.2.0|^8.0" }, "require-dev": { @@ -1042,9 +965,9 @@ "laravel" ], "support": { - "source": "https://github.com/laravel/helpers/tree/v1.8.2" + "source": "https://github.com/laravel/helpers/tree/v1.8.3" }, - "time": "2025-11-25T14:46:28+00:00" + "time": "2026-03-17T16:40:11+00:00" }, { "name": "log1x/wp-smtp", @@ -1085,16 +1008,16 @@ }, { "name": "lstrojny/functional-php", - "version": "1.17.0", + "version": "1.18.0", "source": { "type": "git", "url": "https://github.com/lstrojny/functional-php.git", - "reference": "e459d5cb307bc6e10e9e992c4e96bb71a0262506" + "reference": "c1667dc86f8bc3122aa52b4d11b24d9f5d6ca09a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/lstrojny/functional-php/zipball/e459d5cb307bc6e10e9e992c4e96bb71a0262506", - "reference": "e459d5cb307bc6e10e9e992c4e96bb71a0262506", + "url": "https://api.github.com/repos/lstrojny/functional-php/zipball/c1667dc86f8bc3122aa52b4d11b24d9f5d6ca09a", + "reference": "c1667dc86f8bc3122aa52b4d11b24d9f5d6ca09a", "shasum": "" }, "require": { @@ -1125,6 +1048,7 @@ "src/Functional/DropFirst.php", "src/Functional/DropLast.php", "src/Functional/Each.php", + "src/Functional/Entries.php", "src/Functional/Equal.php", "src/Functional/ErrorToException.php", "src/Functional/Every.php", @@ -1136,6 +1060,7 @@ "src/Functional/FlatMap.php", "src/Functional/Flatten.php", "src/Functional/Flip.php", + "src/Functional/FromEntries.php", "src/Functional/GreaterThan.php", "src/Functional/GreaterThanOrEqual.php", "src/Functional/Group.php", @@ -1227,7 +1152,7 @@ ], "support": { "issues": "https://github.com/lstrojny/functional-php/issues", - "source": "https://github.com/lstrojny/functional-php/tree/1.17.0" + "source": "https://github.com/lstrojny/functional-php/tree/1.18.0" }, "funding": [ { @@ -1235,7 +1160,7 @@ "type": "github" } ], - "time": "2021-03-07T00:25:34+00:00" + "time": "2026-03-21T09:05:40+00:00" }, { "name": "mnsami/composer-custom-directory-installer", @@ -1295,16 +1220,16 @@ }, { "name": "nesbot/carbon", - "version": "3.11.0", + "version": "3.11.4", "source": { "type": "git", "url": "https://github.com/CarbonPHP/carbon.git", - "reference": "bdb375400dcd162624531666db4799b36b64e4a1" + "reference": "e890471a3494740f7d9326d72ce6a8c559ffee60" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/CarbonPHP/carbon/zipball/bdb375400dcd162624531666db4799b36b64e4a1", - "reference": "bdb375400dcd162624531666db4799b36b64e4a1", + "url": "https://api.github.com/repos/CarbonPHP/carbon/zipball/e890471a3494740f7d9326d72ce6a8c559ffee60", + "reference": "e890471a3494740f7d9326d72ce6a8c559ffee60", "shasum": "" }, "require": { @@ -1328,7 +1253,7 @@ "phpstan/extension-installer": "^1.4.3", "phpstan/phpstan": "^2.1.22", "phpunit/phpunit": "^10.5.53", - "squizlabs/php_codesniffer": "^3.13.4" + "squizlabs/php_codesniffer": "^3.13.4 || ^4.0.0" }, "bin": [ "bin/carbon" @@ -1371,14 +1296,14 @@ } ], "description": "An API extension for DateTime that supports 281 different languages.", - "homepage": "https://carbon.nesbot.com", + "homepage": "https://carbonphp.github.io/carbon/", "keywords": [ "date", "datetime", "time" ], "support": { - "docs": "https://carbon.nesbot.com/docs", + "docs": "https://carbonphp.github.io/carbon/guide/getting-started/introduction.html", "issues": "https://github.com/CarbonPHP/carbon/issues", "source": "https://github.com/CarbonPHP/carbon" }, @@ -1396,7 +1321,7 @@ "type": "tidelift" } ], - "time": "2025-12-02T21:04:28+00:00" + "time": "2026-04-07T09:57:54+00:00" }, { "name": "oscarotero/env", @@ -1454,17 +1379,280 @@ "time": "2024-12-03T01:02:28+00:00" }, { - "name": "phpoption/phpoption", - "version": "1.9.4", + "name": "php-standard-library/php-standard-library", + "version": "6.1.1", "source": { "type": "git", - "url": "https://github.com/schmittjoh/php-option.git", - "reference": "638a154f8d4ee6a5cfa96d6a34dfbe0cffa9566d" + "url": "https://github.com/php-standard-library/php-standard-library.git", + "reference": "b7d151cb1c21589cdde17a6adff50d3375de0919" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/schmittjoh/php-option/zipball/638a154f8d4ee6a5cfa96d6a34dfbe0cffa9566d", - "reference": "638a154f8d4ee6a5cfa96d6a34dfbe0cffa9566d", + "url": "https://api.github.com/repos/php-standard-library/php-standard-library/zipball/b7d151cb1c21589cdde17a6adff50d3375de0919", + "reference": "b7d151cb1c21589cdde17a6adff50d3375de0919", + "shasum": "" + }, + "require": { + "ext-bcmath": "*", + "ext-intl": "*", + "ext-json": "*", + "ext-mbstring": "*", + "ext-openssl": "*", + "ext-sodium": "*", + "php": "~8.4.0 || ~8.5.0", + "revolt/event-loop": "^1.0.8" + }, + "conflict": { + "azjezz/psl": "*" + }, + "replace": { + "php-standard-library/ansi": "self.version", + "php-standard-library/async": "self.version", + "php-standard-library/binary": "self.version", + "php-standard-library/cache": "self.version", + "php-standard-library/channel": "self.version", + "php-standard-library/cidr": "self.version", + "php-standard-library/class": "self.version", + "php-standard-library/collection": "self.version", + "php-standard-library/comparison": "self.version", + "php-standard-library/compression": "self.version", + "php-standard-library/crypto": "self.version", + "php-standard-library/data-structure": "self.version", + "php-standard-library/date-time": "self.version", + "php-standard-library/default": "self.version", + "php-standard-library/dict": "self.version", + "php-standard-library/either": "self.version", + "php-standard-library/encoding": "self.version", + "php-standard-library/env": "self.version", + "php-standard-library/file": "self.version", + "php-standard-library/filesystem": "self.version", + "php-standard-library/foundation": "self.version", + "php-standard-library/fun": "self.version", + "php-standard-library/graph": "self.version", + "php-standard-library/h2": "self.version", + "php-standard-library/hash": "self.version", + "php-standard-library/hpack": "self.version", + "php-standard-library/html": "self.version", + "php-standard-library/interface": "self.version", + "php-standard-library/interoperability": "self.version", + "php-standard-library/io": "self.version", + "php-standard-library/ip": "self.version", + "php-standard-library/iri": "self.version", + "php-standard-library/iter": "self.version", + "php-standard-library/json": "self.version", + "php-standard-library/locale": "self.version", + "php-standard-library/math": "self.version", + "php-standard-library/network": "self.version", + "php-standard-library/observer": "self.version", + "php-standard-library/option": "self.version", + "php-standard-library/os": "self.version", + "php-standard-library/password": "self.version", + "php-standard-library/process": "self.version", + "php-standard-library/promise": "self.version", + "php-standard-library/pseudo-random": "self.version", + "php-standard-library/punycode": "self.version", + "php-standard-library/random-sequence": "self.version", + "php-standard-library/range": "self.version", + "php-standard-library/regex": "self.version", + "php-standard-library/result": "self.version", + "php-standard-library/runtime": "self.version", + "php-standard-library/secure-random": "self.version", + "php-standard-library/shell": "self.version", + "php-standard-library/socks": "self.version", + "php-standard-library/str": "self.version", + "php-standard-library/tcp": "self.version", + "php-standard-library/terminal": "self.version", + "php-standard-library/tls": "self.version", + "php-standard-library/trait": "self.version", + "php-standard-library/tree": "self.version", + "php-standard-library/type": "self.version", + "php-standard-library/udp": "self.version", + "php-standard-library/unix": "self.version", + "php-standard-library/uri": "self.version", + "php-standard-library/url": "self.version", + "php-standard-library/vec": "self.version" + }, + "require-dev": { + "carthage-software/mago": "^1.15.2", + "ext-brotli": "*", + "infection/infection": "^0.32.6", + "php-coveralls/php-coveralls": "^2.9.1", + "phpbench/phpbench": "^1.5.1", + "phpunit/phpunit": "^13.0.5" + }, + "suggest": { + "php-standard-library/phpstan-extension": "PHPStan integration", + "php-standard-library/psalm-plugin": "Psalm integration" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-next": "6.1.x-dev" + } + }, + "autoload": { + "files": [ + "packages/foundation/src/Psl/bootstrap.php", + "packages/ansi/src/Psl/bootstrap.php", + "packages/async/src/Psl/bootstrap.php", + "packages/binary/src/Psl/bootstrap.php", + "packages/cache/src/Psl/bootstrap.php", + "packages/channel/src/Psl/bootstrap.php", + "packages/class/src/Psl/bootstrap.php", + "packages/comparison/src/Psl/bootstrap.php", + "packages/compression/src/Psl/bootstrap.php", + "packages/crypto/src/Psl/bootstrap.php", + "packages/date-time/src/Psl/bootstrap.php", + "packages/dict/src/Psl/bootstrap.php", + "packages/encoding/src/Psl/bootstrap.php", + "packages/env/src/Psl/bootstrap.php", + "packages/file/src/Psl/bootstrap.php", + "packages/filesystem/src/Psl/bootstrap.php", + "packages/fun/src/Psl/bootstrap.php", + "packages/graph/src/Psl/bootstrap.php", + "packages/h2/src/Psl/bootstrap.php", + "packages/hash/src/Psl/bootstrap.php", + "packages/hpack/src/Psl/bootstrap.php", + "packages/html/src/Psl/bootstrap.php", + "packages/interface/src/Psl/bootstrap.php", + "packages/io/src/Psl/bootstrap.php", + "packages/iter/src/Psl/bootstrap.php", + "packages/json/src/Psl/bootstrap.php", + "packages/math/src/Psl/bootstrap.php", + "packages/network/src/Psl/bootstrap.php", + "packages/option/src/Psl/bootstrap.php", + "packages/os/src/Psl/bootstrap.php", + "packages/password/src/Psl/bootstrap.php", + "packages/pseudo-random/src/Psl/bootstrap.php", + "packages/punycode/src/Psl/bootstrap.php", + "packages/range/src/Psl/bootstrap.php", + "packages/regex/src/Psl/bootstrap.php", + "packages/result/src/Psl/bootstrap.php", + "packages/runtime/src/Psl/bootstrap.php", + "packages/secure-random/src/Psl/bootstrap.php", + "packages/shell/src/Psl/bootstrap.php", + "packages/socks/src/Psl/bootstrap.php", + "packages/str/src/Psl/bootstrap.php", + "packages/tcp/src/Psl/bootstrap.php", + "packages/terminal/src/Psl/bootstrap.php", + "packages/tls/src/Psl/bootstrap.php", + "packages/trait/src/Psl/bootstrap.php", + "packages/tree/src/Psl/bootstrap.php", + "packages/type/src/Psl/bootstrap.php", + "packages/udp/src/Psl/bootstrap.php", + "packages/unix/src/Psl/bootstrap.php", + "packages/uri/src/Psl/bootstrap.php", + "packages/url/src/Psl/bootstrap.php", + "packages/iri/src/Psl/bootstrap.php", + "packages/vec/src/Psl/bootstrap.php" + ], + "psr-4": { + "Psl\\": "packages/foundation/src/Psl/", + "Psl\\H2\\": "packages/h2/src/Psl/H2/", + "Psl\\IO\\": "packages/io/src/Psl/IO/", + "Psl\\IP\\": "packages/ip/src/Psl/IP/", + "Psl\\OS\\": "packages/os/src/Psl/OS/", + "Psl\\Env\\": "packages/env/src/Psl/Env/", + "Psl\\Fun\\": "packages/fun/src/Psl/Fun/", + "Psl\\IRI\\": "packages/iri/src/Psl/IRI/", + "Psl\\Str\\": "packages/str/src/Psl/Str/", + "Psl\\TCP\\": "packages/tcp/src/Psl/TCP/", + "Psl\\TLS\\": "packages/tls/src/Psl/TLS/", + "Psl\\UDP\\": "packages/udp/src/Psl/UDP/", + "Psl\\URI\\": "packages/uri/src/Psl/URI/", + "Psl\\URL\\": "packages/url/src/Psl/URL/", + "Psl\\Vec\\": "packages/vec/src/Psl/Vec/", + "Psl\\Ansi\\": "packages/ansi/src/Psl/Ansi/", + "Psl\\CIDR\\": "packages/cidr/src/Psl/CIDR/", + "Psl\\Dict\\": "packages/dict/src/Psl/Dict/", + "Psl\\File\\": "packages/file/src/Psl/File/", + "Psl\\Hash\\": "packages/hash/src/Psl/Hash/", + "Psl\\Html\\": "packages/html/src/Psl/Html/", + "Psl\\Iter\\": "packages/iter/src/Psl/Iter/", + "Psl\\Json\\": "packages/json/src/Psl/Json/", + "Psl\\Math\\": "packages/math/src/Psl/Math/", + "Psl\\Tree\\": "packages/tree/src/Psl/Tree/", + "Psl\\Type\\": "packages/type/src/Psl/Type/", + "Psl\\Unix\\": "packages/unix/src/Psl/Unix/", + "Psl\\Async\\": "packages/async/src/Psl/Async/", + "Psl\\Cache\\": "packages/cache/src/Psl/Cache/", + "Psl\\Class\\": "packages/class/src/Psl/Class/", + "Psl\\Graph\\": "packages/graph/src/Psl/Graph/", + "Psl\\HPACK\\": "packages/hpack/src/Psl/HPACK/", + "Psl\\Range\\": "packages/range/src/Psl/Range/", + "Psl\\Regex\\": "packages/regex/src/Psl/Regex/", + "Psl\\Shell\\": "packages/shell/src/Psl/Shell/", + "Psl\\Socks\\": "packages/socks/src/Psl/Socks/", + "Psl\\Trait\\": "packages/trait/src/Psl/Trait/", + "Psl\\Binary\\": "packages/binary/src/Psl/Binary/", + "Psl\\Crypto\\": "packages/crypto/src/Psl/Crypto/", + "Psl\\Either\\": "packages/either/src/Psl/Either/", + "Psl\\Locale\\": "packages/locale/src/Psl/Locale/", + "Psl\\Option\\": "packages/option/src/Psl/Option/", + "Psl\\Result\\": "packages/result/src/Psl/Result/", + "Psl\\Channel\\": "packages/channel/src/Psl/Channel/", + "Psl\\Default\\": "packages/default/src/Psl/Default/", + "Psl\\Network\\": "packages/network/src/Psl/Network/", + "Psl\\Process\\": "packages/process/src/Psl/Process/", + "Psl\\Promise\\": "packages/promise/src/Psl/Promise/", + "Psl\\Runtime\\": "packages/runtime/src/Psl/Runtime/", + "Psl\\DateTime\\": "packages/date-time/src/Psl/DateTime/", + "Psl\\Encoding\\": "packages/encoding/src/Psl/Encoding/", + "Psl\\Observer\\": "packages/observer/src/Psl/Observer/", + "Psl\\Password\\": "packages/password/src/Psl/Password/", + "Psl\\Punycode\\": "packages/punycode/src/Psl/Punycode/", + "Psl\\Terminal\\": "packages/terminal/src/Psl/Terminal/", + "Psl\\Interface\\": "packages/interface/src/Psl/Interface/", + "Psl\\Collection\\": "packages/collection/src/Psl/Collection/", + "Psl\\Comparison\\": "packages/comparison/src/Psl/Comparison/", + "Psl\\Filesystem\\": "packages/filesystem/src/Psl/Filesystem/", + "Psl\\Compression\\": "packages/compression/src/Psl/Compression/", + "Psl\\PseudoRandom\\": "packages/pseudo-random/src/Psl/PseudoRandom/", + "Psl\\SecureRandom\\": "packages/secure-random/src/Psl/SecureRandom/", + "Psl\\DataStructure\\": "packages/data-structure/src/Psl/DataStructure/", + "Psl\\RandomSequence\\": "packages/random-sequence/src/Psl/RandomSequence/", + "Psl\\Interoperability\\": "packages/interoperability/src/Psl/Interoperability/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "azjezz", + "email": "azjezz@protonmail.com" + } + ], + "description": "PHP Standard Library", + "support": { + "issues": "https://github.com/php-standard-library/php-standard-library/issues", + "source": "https://github.com/php-standard-library/php-standard-library/tree/6.1.1" + }, + "funding": [ + { + "url": "https://github.com/azjezz", + "type": "github" + }, + { + "url": "https://github.com/veewee", + "type": "github" + } + ], + "time": "2026-03-20T08:09:20+00:00" + }, + { + "name": "phpoption/phpoption", + "version": "1.9.5", + "source": { + "type": "git", + "url": "https://github.com/schmittjoh/php-option.git", + "reference": "75365b91986c2405cf5e1e012c5595cd487a98be" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/schmittjoh/php-option/zipball/75365b91986c2405cf5e1e012c5595cd487a98be", + "reference": "75365b91986c2405cf5e1e012c5595cd487a98be", "shasum": "" }, "require": { @@ -1514,7 +1702,7 @@ ], "support": { "issues": "https://github.com/schmittjoh/php-option/issues", - "source": "https://github.com/schmittjoh/php-option/tree/1.9.4" + "source": "https://github.com/schmittjoh/php-option/tree/1.9.5" }, "funding": [ { @@ -1526,7 +1714,7 @@ "type": "tidelift" } ], - "time": "2025-08-21T11:53:16+00:00" + "time": "2025-12-27T19:41:33+00:00" }, { "name": "psr/clock", @@ -1754,16 +1942,16 @@ }, { "name": "roots/bedrock-autoloader", - "version": "1.0.4", + "version": "1.1.0", "source": { "type": "git", "url": "https://github.com/roots/bedrock-autoloader.git", - "reference": "f508348a3365ab5ce7e045f5fd4ee9f0a30dd70f" + "reference": "4cf086073bcb44b72f9e8da922043e86d09da9ce" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/roots/bedrock-autoloader/zipball/f508348a3365ab5ce7e045f5fd4ee9f0a30dd70f", - "reference": "f508348a3365ab5ce7e045f5fd4ee9f0a30dd70f", + "url": "https://api.github.com/repos/roots/bedrock-autoloader/zipball/4cf086073bcb44b72f9e8da922043e86d09da9ce", + "reference": "4cf086073bcb44b72f9e8da922043e86d09da9ce", "shasum": "" }, "require": { @@ -1798,6 +1986,11 @@ "name": "Austin Pray", "email": "austin@austinpray.com", "homepage": "https://github.com/austinpray" + }, + { + "name": "Ben Word", + "email": "ben@benword.com", + "homepage": "https://github.com/retlehs" } ], "description": "An autoloader that enables standard plugins to be required just like must-use plugins", @@ -1812,36 +2005,35 @@ "support": { "forum": "https://discourse.roots.io/", "issues": "https://github.com/roots/bedrock-autoloader/issues", - "source": "https://github.com/roots/bedrock-autoloader/tree/1.0.4" + "source": "https://github.com/roots/bedrock-autoloader/tree/1.1.0" }, "funding": [ { "url": "https://github.com/roots", "type": "github" - }, - { - "url": "https://www.patreon.com/rootsdev", - "type": "patreon" } ], - "time": "2020-12-04T15:59:12+00:00" + "time": "2026-03-09T23:11:00+00:00" }, { "name": "roots/bedrock-disallow-indexing", - "version": "2.0.0", + "version": "2.1.0", "source": { "type": "git", "url": "https://github.com/roots/bedrock-disallow-indexing.git", - "reference": "6c28192e17cb9e02a5c0c99691a18552b85e1615" + "reference": "e9f20bf1c2baf96daf80ebab3f4cfbb756b5c88c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/roots/bedrock-disallow-indexing/zipball/6c28192e17cb9e02a5c0c99691a18552b85e1615", - "reference": "6c28192e17cb9e02a5c0c99691a18552b85e1615", + "url": "https://api.github.com/repos/roots/bedrock-disallow-indexing/zipball/e9f20bf1c2baf96daf80ebab3f4cfbb756b5c88c", + "reference": "e9f20bf1c2baf96daf80ebab3f4cfbb756b5c88c", "shasum": "" }, "require": { - "php": ">=7.1" + "php": ">=8.2" + }, + "require-dev": { + "laravel/pint": "^1.27" }, "type": "wordpress-muplugin", "notification-url": "https://packagist.org/downloads/", @@ -1872,32 +2064,28 @@ "support": { "forum": "https://discourse.roots.io/", "issues": "https://github.com/roots/bedrock-disallow-indexing/issues", - "source": "https://github.com/roots/bedrock-disallow-indexing/tree/2.0.0" + "source": "https://github.com/roots/bedrock-disallow-indexing/tree/2.1.0" }, "funding": [ { "url": "https://github.com/roots", "type": "github" - }, - { - "url": "https://www.patreon.com/rootsdev", - "type": "patreon" } ], - "time": "2020-05-20T01:25:07+00:00" + "time": "2026-03-10T01:48:06+00:00" }, { "name": "roots/wordpress", - "version": "6.9", + "version": "6.9.4", "source": { "type": "git", "url": "https://github.com/roots/wordpress.git", - "reference": "29e4eb49b2f4c591e39d4eb6705a27cf1ea40e45" + "reference": "2fa44383ade9e8ccbb986e95ca70a365c8221eb1" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/roots/wordpress/zipball/29e4eb49b2f4c591e39d4eb6705a27cf1ea40e45", - "reference": "29e4eb49b2f4c591e39d4eb6705a27cf1ea40e45", + "url": "https://api.github.com/repos/roots/wordpress/zipball/2fa44383ade9e8ccbb986e95ca70a365c8221eb1", + "reference": "2fa44383ade9e8ccbb986e95ca70a365c8221eb1", "shasum": "" }, "require": { @@ -1919,7 +2107,7 @@ ], "support": { "issues": "https://github.com/roots/wordpress/issues", - "source": "https://github.com/roots/wordpress/tree/6.9" + "source": "https://github.com/roots/wordpress/tree/6.9.4" }, "funding": [ { @@ -1927,7 +2115,7 @@ "type": "github" } ], - "time": "2025-05-23T18:54:22+00:00" + "time": "2026-03-09T19:47:29+00:00" }, { "name": "roots/wordpress-core-installer", @@ -1998,23 +2186,23 @@ }, { "name": "roots/wordpress-no-content", - "version": "6.9", + "version": "6.9.4", "source": { "type": "git", "url": "https://github.com/WordPress/WordPress.git", - "reference": "6.9" + "reference": "6.9.4" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/release/wordpress-6.9-no-content.zip", - "reference": "6.9", - "shasum": "2d8cb4b253b690e255afde1d451e87380e6a5cb5" + "url": "https://downloads.w.org/release/wordpress-6.9.4-no-content.zip", + "reference": "6.9.4", + "shasum": "8ae812bb54223ef859cd3de37f1c6b1db20e0e6f" }, "require": { "php": ">= 7.2.24" }, "provide": { - "wordpress/core-implementation": "6.9" + "wordpress/core-implementation": "6.9.4" }, "suggest": { "ext-curl": "Performs remote request operations.", @@ -2065,7 +2253,7 @@ "type": "other" } ], - "time": "2025-12-02T19:09:36+00:00" + "time": "2026-03-11T15:49:55+00:00" }, { "name": "roots/wp-config", @@ -2115,16 +2303,16 @@ }, { "name": "stripe/stripe-php", - "version": "v16.6.0", + "version": "v19.4.1", "source": { "type": "git", "url": "https://github.com/stripe/stripe-php.git", - "reference": "d6de0a536f00b5c5c74f36b8f4d0d93b035499ff" + "reference": "095384404587d07de2ad1154c389c4051c5ed92f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/stripe/stripe-php/zipball/d6de0a536f00b5c5c74f36b8f4d0d93b035499ff", - "reference": "d6de0a536f00b5c5c74f36b8f4d0d93b035499ff", + "url": "https://api.github.com/repos/stripe/stripe-php/zipball/095384404587d07de2ad1154c389c4051c5ed92f", + "reference": "095384404587d07de2ad1154c389c4051c5ed92f", "shasum": "" }, "require": { @@ -2134,7 +2322,7 @@ "php": ">=5.6.0" }, "require-dev": { - "friendsofphp/php-cs-fixer": "3.5.0", + "friendsofphp/php-cs-fixer": "3.94.0", "phpstan/phpstan": "^1.2", "phpunit/phpunit": "^5.7 || ^9.0" }, @@ -2168,22 +2356,22 @@ ], "support": { "issues": "https://github.com/stripe/stripe-php/issues", - "source": "https://github.com/stripe/stripe-php/tree/v16.6.0" + "source": "https://github.com/stripe/stripe-php/tree/v19.4.1" }, - "time": "2025-02-24T22:35:29+00:00" + "time": "2026-03-06T22:53:13+00:00" }, { "name": "symfony/clock", - "version": "v8.0.0", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/clock.git", - "reference": "832119f9b8dbc6c8e6f65f30c5969eca1e88764f" + "reference": "b55a638b189a6faa875e0ccdb00908fb87af95b3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/clock/zipball/832119f9b8dbc6c8e6f65f30c5969eca1e88764f", - "reference": "832119f9b8dbc6c8e6f65f30c5969eca1e88764f", + "url": "https://api.github.com/repos/symfony/clock/zipball/b55a638b189a6faa875e0ccdb00908fb87af95b3", + "reference": "b55a638b189a6faa875e0ccdb00908fb87af95b3", "shasum": "" }, "require": { @@ -2227,7 +2415,7 @@ "time" ], "support": { - "source": "https://github.com/symfony/clock/tree/v8.0.0" + "source": "https://github.com/symfony/clock/tree/v8.0.8" }, "funding": [ { @@ -2247,7 +2435,7 @@ "type": "tidelift" } ], - "time": "2025-11-12T15:46:48+00:00" + "time": "2026-03-30T15:14:47+00:00" }, { "name": "symfony/deprecation-contracts", @@ -2318,16 +2506,16 @@ }, { "name": "symfony/polyfill-ctype", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-ctype.git", - "reference": "a3cc8b044a6ea513310cbd48ef7333b384945638" + "reference": "141046a8f9477948ff284fa65be2095baafb94f2" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/a3cc8b044a6ea513310cbd48ef7333b384945638", - "reference": "a3cc8b044a6ea513310cbd48ef7333b384945638", + "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/141046a8f9477948ff284fa65be2095baafb94f2", + "reference": "141046a8f9477948ff284fa65be2095baafb94f2", "shasum": "" }, "require": { @@ -2377,7 +2565,7 @@ "portable" ], "support": { - "source": "https://github.com/symfony/polyfill-ctype/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-ctype/tree/v1.37.0" }, "funding": [ { @@ -2397,20 +2585,20 @@ "type": "tidelift" } ], - "time": "2024-09-09T11:45:10+00:00" + "time": "2026-04-10T16:19:22+00:00" }, { "name": "symfony/polyfill-mbstring", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-mbstring.git", - "reference": "6d857f4d76bd4b343eac26d6b539585d2bc56493" + "reference": "6a21eb99c6973357967f6ce3708cd55a6bec6315" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/6d857f4d76bd4b343eac26d6b539585d2bc56493", - "reference": "6d857f4d76bd4b343eac26d6b539585d2bc56493", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/6a21eb99c6973357967f6ce3708cd55a6bec6315", + "reference": "6a21eb99c6973357967f6ce3708cd55a6bec6315", "shasum": "" }, "require": { @@ -2462,7 +2650,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.37.0" }, "funding": [ { @@ -2482,20 +2670,20 @@ "type": "tidelift" } ], - "time": "2024-12-23T08:48:59+00:00" + "time": "2026-04-10T17:25:58+00:00" }, { "name": "symfony/polyfill-php80", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php80.git", - "reference": "0cc9dd0f17f61d8131e7df6b84bd344899fe2608" + "reference": "dfb55726c3a76ea3b6459fcfda1ec2d80a682411" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/0cc9dd0f17f61d8131e7df6b84bd344899fe2608", - "reference": "0cc9dd0f17f61d8131e7df6b84bd344899fe2608", + "url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/dfb55726c3a76ea3b6459fcfda1ec2d80a682411", + "reference": "dfb55726c3a76ea3b6459fcfda1ec2d80a682411", "shasum": "" }, "require": { @@ -2546,7 +2734,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-php80/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-php80/tree/v1.37.0" }, "funding": [ { @@ -2566,100 +2754,20 @@ "type": "tidelift" } ], - "time": "2025-01-02T08:10:11+00:00" - }, - { - "name": "symfony/polyfill-php83", - "version": "v1.33.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-php83.git", - "reference": "17f6f9a6b1735c0f163024d959f700cfbc5155e5" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php83/zipball/17f6f9a6b1735c0f163024d959f700cfbc5155e5", - "reference": "17f6f9a6b1735c0f163024d959f700cfbc5155e5", - "shasum": "" - }, - "require": { - "php": ">=7.2" - }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/symfony/polyfill", - "name": "symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Php83\\": "" - }, - "classmap": [ - "Resources/stubs" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill backporting some PHP 8.3+ features to lower PHP versions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-php83/tree/v1.33.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2025-07-08T02:45:35+00:00" + "time": "2026-04-10T16:19:22+00:00" }, { "name": "symfony/polyfill-php84", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php84.git", - "reference": "d8ced4d875142b6a7426000426b8abc631d6b191" + "reference": "88486db2c389b290bf87ff1de7ebc1e13e42bb06" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php84/zipball/d8ced4d875142b6a7426000426b8abc631d6b191", - "reference": "d8ced4d875142b6a7426000426b8abc631d6b191", + "url": "https://api.github.com/repos/symfony/polyfill-php84/zipball/88486db2c389b290bf87ff1de7ebc1e13e42bb06", + "reference": "88486db2c389b290bf87ff1de7ebc1e13e42bb06", "shasum": "" }, "require": { @@ -2706,7 +2814,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-php84/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-php84/tree/v1.37.0" }, "funding": [ { @@ -2726,20 +2834,20 @@ "type": "tidelift" } ], - "time": "2025-06-24T13:30:11+00:00" + "time": "2026-04-10T18:47:49+00:00" }, { "name": "symfony/polyfill-php85", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php85.git", - "reference": "d4e5fcd4ab3d998ab16c0db48e6cbb9a01993f91" + "reference": "fcfa4973a9917cef23f2e38774da74a2b7d115ee" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php85/zipball/d4e5fcd4ab3d998ab16c0db48e6cbb9a01993f91", - "reference": "d4e5fcd4ab3d998ab16c0db48e6cbb9a01993f91", + "url": "https://api.github.com/repos/symfony/polyfill-php85/zipball/fcfa4973a9917cef23f2e38774da74a2b7d115ee", + "reference": "fcfa4973a9917cef23f2e38774da74a2b7d115ee", "shasum": "" }, "require": { @@ -2786,7 +2894,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-php85/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-php85/tree/v1.37.0" }, "funding": [ { @@ -2806,20 +2914,20 @@ "type": "tidelift" } ], - "time": "2025-06-23T16:12:55+00:00" + "time": "2026-04-26T13:10:57+00:00" }, { "name": "symfony/polyfill-uuid", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-uuid.git", - "reference": "21533be36c24be3f4b1669c4725c7d1d2bab4ae2" + "reference": "26dfec253c4cf3e51b541b52ddf7e42cb0908e94" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-uuid/zipball/21533be36c24be3f4b1669c4725c7d1d2bab4ae2", - "reference": "21533be36c24be3f4b1669c4725c7d1d2bab4ae2", + "url": "https://api.github.com/repos/symfony/polyfill-uuid/zipball/26dfec253c4cf3e51b541b52ddf7e42cb0908e94", + "reference": "26dfec253c4cf3e51b541b52ddf7e42cb0908e94", "shasum": "" }, "require": { @@ -2869,7 +2977,7 @@ "uuid" ], "support": { - "source": "https://github.com/symfony/polyfill-uuid/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-uuid/tree/v1.37.0" }, "funding": [ { @@ -2889,20 +2997,20 @@ "type": "tidelift" } ], - "time": "2024-09-09T11:45:10+00:00" + "time": "2026-04-10T16:19:22+00:00" }, { "name": "symfony/translation", - "version": "v8.0.1", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/translation.git", - "reference": "770e3b8b0ba8360958abedcabacd4203467333ca" + "reference": "27c03ae3940de24ba2f71cfdbac824f2aa1fdf2f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/translation/zipball/770e3b8b0ba8360958abedcabacd4203467333ca", - "reference": "770e3b8b0ba8360958abedcabacd4203467333ca", + "url": "https://api.github.com/repos/symfony/translation/zipball/27c03ae3940de24ba2f71cfdbac824f2aa1fdf2f", + "reference": "27c03ae3940de24ba2f71cfdbac824f2aa1fdf2f", "shasum": "" }, "require": { @@ -2962,7 +3070,7 @@ "description": "Provides tools to internationalize your application", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/translation/tree/v8.0.1" + "source": "https://github.com/symfony/translation/tree/v8.0.8" }, "funding": [ { @@ -2982,7 +3090,7 @@ "type": "tidelift" } ], - "time": "2025-12-01T09:13:36+00:00" + "time": "2026-03-30T15:14:47+00:00" }, { "name": "symfony/translation-contracts", @@ -3068,16 +3176,16 @@ }, { "name": "symfony/uid", - "version": "v8.0.0", + "version": "v8.0.9", "source": { "type": "git", "url": "https://github.com/symfony/uid.git", - "reference": "8395a2cc2ed49aa68f602c5c489f60ab853893df" + "reference": "4d9d6510bbe88ebb4608b7200d18606cdf80825c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/uid/zipball/8395a2cc2ed49aa68f602c5c489f60ab853893df", - "reference": "8395a2cc2ed49aa68f602c5c489f60ab853893df", + "url": "https://api.github.com/repos/symfony/uid/zipball/4d9d6510bbe88ebb4608b7200d18606cdf80825c", + "reference": "4d9d6510bbe88ebb4608b7200d18606cdf80825c", "shasum": "" }, "require": { @@ -3122,7 +3230,7 @@ "uuid" ], "support": { - "source": "https://github.com/symfony/uid/tree/v8.0.0" + "source": "https://github.com/symfony/uid/tree/v8.0.9" }, "funding": [ { @@ -3142,42 +3250,58 @@ "type": "tidelift" } ], - "time": "2025-09-26T07:52:19+00:00" + "time": "2026-04-30T16:10:06+00:00" }, { "name": "timber/timber", - "version": "v2.3.3", + "version": "v2.4.0", "source": { "type": "git", "url": "https://github.com/timber/timber.git", - "reference": "7a87ac27c0b9deedffe419388b63a0c95d8798ca" + "reference": "44c7171d154ee697bab416a31852b9340845cc7f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/timber/timber/zipball/7a87ac27c0b9deedffe419388b63a0c95d8798ca", - "reference": "7a87ac27c0b9deedffe419388b63a0c95d8798ca", + "url": "https://api.github.com/repos/timber/timber/zipball/44c7171d154ee697bab416a31852b9340845cc7f", + "reference": "44c7171d154ee697bab416a31852b9340845cc7f", "shasum": "" }, "require": { - "php": "^8.1", + "php": "^8.2", "twig/twig": "^3.19" }, "require-dev": { + "composer/installers": "^2", "ergebnis/composer-normalize": "^2.28", + "ergebnis/phpunit-slow-test-detector": "^2.20", + "mantle-framework/cache": "^1.16", + "mantle-framework/config": "^1.16", + "mantle-framework/container": "^1.16", + "mantle-framework/contracts": "^1.16", + "mantle-framework/database": "^1.16", + "mantle-framework/events": "^1.16", + "mantle-framework/faker": "^1.15", + "mantle-framework/filesystem": "^1.16", + "mantle-framework/framework-views": "^1.16", + "mantle-framework/http": "^1.16", + "mantle-framework/http-client": "^1.16", + "mantle-framework/support": "^1.16", + "mantle-framework/testing": "^1.16", + "mantle-framework/testkit": "^1.16", + "mantle-framework/view": "^1.16", "php-parallel-lint/php-parallel-lint": "^1.3", "php-stubs/wp-cli-stubs": "^2.0", "phpro/grumphp": "^2.0", "phpstan/extension-installer": "^1.1", "phpstan/phpstan": "^2", - "phpunit/phpunit": "^9.0", + "phpunit/phpunit": "^11.5 || ^12", "rector/rector": "^2.0", "squizlabs/php_codesniffer": "^3.0", - "symplify/easy-coding-standard": "^12", + "symplify/easy-coding-standard": "^13", "szepeviktor/phpstan-wordpress": "^2", "twig/cache-extra": "^3.17", - "wpackagist-plugin/advanced-custom-fields": "^6.0", - "wpackagist-plugin/co-authors-plus": "^3.6", - "yoast/wp-test-utils": "^1.2" + "wp-plugin/advanced-custom-fields": "^6.5", + "wp-plugin/co-authors-plus": "^3.6" }, "suggest": { "php-coveralls/php-coveralls": "^2.0 for code coverage", @@ -3243,20 +3367,20 @@ "type": "open_collective" } ], - "time": "2025-09-24T14:07:33+00:00" + "time": "2026-04-20T08:31:34+00:00" }, { "name": "twig/twig", - "version": "v3.22.2", + "version": "v3.24.0", "source": { "type": "git", "url": "https://github.com/twigphp/Twig.git", - "reference": "946ddeafa3c9f4ce279d1f34051af041db0e16f2" + "reference": "a6769aefb305efef849dc25c9fd1653358c148f0" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/twigphp/Twig/zipball/946ddeafa3c9f4ce279d1f34051af041db0e16f2", - "reference": "946ddeafa3c9f4ce279d1f34051af041db0e16f2", + "url": "https://api.github.com/repos/twigphp/Twig/zipball/a6769aefb305efef849dc25c9fd1653358c148f0", + "reference": "a6769aefb305efef849dc25c9fd1653358c148f0", "shasum": "" }, "require": { @@ -3266,7 +3390,8 @@ "symfony/polyfill-mbstring": "^1.3" }, "require-dev": { - "phpstan/phpstan": "^2.0", + "php-cs-fixer/shim": "^3.0@stable", + "phpstan/phpstan": "^2.0@stable", "psr/container": "^1.0|^2.0", "symfony/phpunit-bridge": "^5.4.9|^6.4|^7.0" }, @@ -3310,7 +3435,7 @@ ], "support": { "issues": "https://github.com/twigphp/Twig/issues", - "source": "https://github.com/twigphp/Twig/tree/v3.22.2" + "source": "https://github.com/twigphp/Twig/tree/v3.24.0" }, "funding": [ { @@ -3322,30 +3447,30 @@ "type": "tidelift" } ], - "time": "2025-12-14T11:28:47+00:00" + "time": "2026-03-17T21:31:11+00:00" }, { "name": "vlucas/phpdotenv", - "version": "v5.6.2", + "version": "v5.6.3", "source": { "type": "git", "url": "https://github.com/vlucas/phpdotenv.git", - "reference": "24ac4c74f91ee2c193fa1aaa5c249cb0822809af" + "reference": "955e7815d677a3eaa7075231212f2110983adecc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/vlucas/phpdotenv/zipball/24ac4c74f91ee2c193fa1aaa5c249cb0822809af", - "reference": "24ac4c74f91ee2c193fa1aaa5c249cb0822809af", + "url": "https://api.github.com/repos/vlucas/phpdotenv/zipball/955e7815d677a3eaa7075231212f2110983adecc", + "reference": "955e7815d677a3eaa7075231212f2110983adecc", "shasum": "" }, "require": { "ext-pcre": "*", - "graham-campbell/result-type": "^1.1.3", + "graham-campbell/result-type": "^1.1.4", "php": "^7.2.5 || ^8.0", - "phpoption/phpoption": "^1.9.3", - "symfony/polyfill-ctype": "^1.24", - "symfony/polyfill-mbstring": "^1.24", - "symfony/polyfill-php80": "^1.24" + "phpoption/phpoption": "^1.9.5", + "symfony/polyfill-ctype": "^1.26", + "symfony/polyfill-mbstring": "^1.26", + "symfony/polyfill-php80": "^1.26" }, "require-dev": { "bamarni/composer-bin-plugin": "^1.8.2", @@ -3394,7 +3519,7 @@ ], "support": { "issues": "https://github.com/vlucas/phpdotenv/issues", - "source": "https://github.com/vlucas/phpdotenv/tree/v5.6.2" + "source": "https://github.com/vlucas/phpdotenv/tree/v5.6.3" }, "funding": [ { @@ -3406,27 +3531,27 @@ "type": "tidelift" } ], - "time": "2025-04-30T23:37:27+00:00" + "time": "2025-12-27T19:49:13+00:00" }, { "name": "voku/portable-ascii", - "version": "2.0.3", + "version": "2.1.1", "source": { "type": "git", "url": "https://github.com/voku/portable-ascii.git", - "reference": "b1d923f88091c6bf09699efcd7c8a1b1bfd7351d" + "reference": "8e1051fe39379367aecf014f41744ce7539a856f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/voku/portable-ascii/zipball/b1d923f88091c6bf09699efcd7c8a1b1bfd7351d", - "reference": "b1d923f88091c6bf09699efcd7c8a1b1bfd7351d", + "url": "https://api.github.com/repos/voku/portable-ascii/zipball/8e1051fe39379367aecf014f41744ce7539a856f", + "reference": "8e1051fe39379367aecf014f41744ce7539a856f", "shasum": "" }, "require": { - "php": ">=7.0.0" + "php": ">=7.1.0" }, "require-dev": { - "phpunit/phpunit": "~6.0 || ~7.0 || ~9.0" + "phpunit/phpunit": "~8.5 || ~9.6 || ~10.5 || ~11.5" }, "suggest": { "ext-intl": "Use Intl for transliterator_transliterate() support" @@ -3456,7 +3581,7 @@ ], "support": { "issues": "https://github.com/voku/portable-ascii/issues", - "source": "https://github.com/voku/portable-ascii/tree/2.0.3" + "source": "https://github.com/voku/portable-ascii/tree/2.1.1" }, "funding": [ { @@ -3480,19 +3605,19 @@ "type": "tidelift" } ], - "time": "2024-11-21T01:49:47+00:00" + "time": "2026-04-26T05:33:54+00:00" }, { "name": "wpackagist-plugin/falcon", - "version": "2.9.2", + "version": "2.10.0", "source": { "type": "svn", "url": "https://plugins.svn.wordpress.org/falcon/", - "reference": "tags/2.9.2" + "reference": "tags/2.10.0" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/plugin/falcon.2.9.2.zip" + "url": "https://downloads.wordpress.org/plugin/falcon.2.10.0.zip" }, "require": { "composer/installers": "^1.0 || ^2.0" @@ -3502,15 +3627,15 @@ }, { "name": "wpackagist-plugin/force-regenerate-thumbnails", - "version": "2.2.2", + "version": "2.3.0", "source": { "type": "svn", "url": "https://plugins.svn.wordpress.org/force-regenerate-thumbnails/", - "reference": "tags/2.2.2" + "reference": "tags/2.3.0" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/plugin/force-regenerate-thumbnails.2.2.2.zip" + "url": "https://downloads.wordpress.org/plugin/force-regenerate-thumbnails.2.3.0.zip" }, "require": { "composer/installers": "^1.0 || ^2.0" @@ -3520,15 +3645,15 @@ }, { "name": "wpackagist-plugin/query-monitor", - "version": "3.20.2", + "version": "4.0.6", "source": { "type": "svn", "url": "https://plugins.svn.wordpress.org/query-monitor/", - "reference": "tags/3.20.2" + "reference": "tags/4.0.6" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/plugin/query-monitor.3.20.2.zip" + "url": "https://downloads.wordpress.org/plugin/query-monitor.4.0.6.zip" }, "require": { "composer/installers": "^1.0 || ^2.0" @@ -3556,15 +3681,15 @@ }, { "name": "wpackagist-plugin/wc-multishipping", - "version": "3.0.0", + "version": "3.0.2", "source": { "type": "svn", "url": "https://plugins.svn.wordpress.org/wc-multishipping/", - "reference": "tags/3.0.0" + "reference": "tags/3.0.2" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/plugin/wc-multishipping.3.0.0.zip" + "url": "https://downloads.wordpress.org/plugin/wc-multishipping.3.0.2.zip" }, "require": { "composer/installers": "^1.0 || ^2.0" @@ -3592,15 +3717,15 @@ }, { "name": "wpackagist-plugin/woocommerce", - "version": "10.4.2", + "version": "10.7.0", "source": { "type": "svn", "url": "https://plugins.svn.wordpress.org/woocommerce/", - "reference": "tags/10.4.2" + "reference": "tags/10.7.0" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/plugin/woocommerce.10.4.2.zip" + "url": "https://downloads.wordpress.org/plugin/woocommerce.10.7.0.zip" }, "require": { "composer/installers": "^1.0 || ^2.0" @@ -3610,15 +3735,15 @@ }, { "name": "wpackagist-plugin/wp-mail-logging", - "version": "1.15.0", + "version": "1.16.0", "source": { "type": "svn", "url": "https://plugins.svn.wordpress.org/wp-mail-logging/", - "reference": "tags/1.15.0" + "reference": "tags/1.16.0" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/plugin/wp-mail-logging.1.15.0.zip" + "url": "https://downloads.wordpress.org/plugin/wp-mail-logging.1.16.0.zip" }, "require": { "composer/installers": "^1.0 || ^2.0" @@ -3628,15 +3753,15 @@ }, { "name": "wpackagist-plugin/wp-mail-smtp", - "version": "4.7.1", + "version": "4.8.0", "source": { "type": "svn", "url": "https://plugins.svn.wordpress.org/wp-mail-smtp/", - "reference": "tags/4.7.1" + "reference": "tags/4.8.0" }, "dist": { "type": "zip", - "url": "https://downloads.wordpress.org/plugin/wp-mail-smtp.4.7.1.zip" + "url": "https://downloads.wordpress.org/plugin/wp-mail-smtp.4.8.0.zip" }, "require": { "composer/installers": "^1.0 || ^2.0" @@ -3968,6 +4093,75 @@ ], "time": "2024-05-06T16:37:16+00:00" }, + { + "name": "ergebnis/agent-detector", + "version": "1.1.1", + "source": { + "type": "git", + "url": "https://github.com/ergebnis/agent-detector.git", + "reference": "5b654a9f1ff8a5d2ce6a57568df5ae8801c87f64" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/ergebnis/agent-detector/zipball/5b654a9f1ff8a5d2ce6a57568df5ae8801c87f64", + "reference": "5b654a9f1ff8a5d2ce6a57568df5ae8801c87f64", + "shasum": "" + }, + "require": { + "php": "~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0 || ~8.6.0" + }, + "require-dev": { + "ergebnis/composer-normalize": "^2.50.0", + "ergebnis/license": "^2.7.0", + "ergebnis/php-cs-fixer-config": "^6.60.2", + "ergebnis/phpstan-rules": "^2.13.1", + "ergebnis/phpunit-slow-test-detector": "^2.24.0", + "ergebnis/rector-rules": "^1.16.0", + "fakerphp/faker": "^1.24.1", + "infection/infection": "^0.26.6", + "phpstan/extension-installer": "^1.4.3", + "phpstan/phpstan": "^2.1.46", + "phpstan/phpstan-deprecation-rules": "^2.0.4", + "phpstan/phpstan-phpunit": "^2.0.16", + "phpstan/phpstan-strict-rules": "^2.0.10", + "phpunit/phpunit": "^9.6.34", + "rector/rector": "^2.4.1" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.0-dev" + }, + "composer-normalize": { + "indent-size": 2, + "indent-style": "space" + } + }, + "autoload": { + "psr-4": { + "Ergebnis\\AgentDetector\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Andreas Möller", + "email": "am@localheinz.com", + "homepage": "https://localheinz.com" + } + ], + "description": "Provides a detector for detecting the presence of an agent.", + "homepage": "https://github.com/ergebnis/agent-detector", + "support": { + "issues": "https://github.com/ergebnis/agent-detector/issues", + "security": "https://github.com/ergebnis/agent-detector/blob/main/.github/SECURITY.md", + "source": "https://github.com/ergebnis/agent-detector" + }, + "time": "2026-04-10T13:45:13+00:00" + }, { "name": "evenement/evenement", "version": "v3.0.2", @@ -4078,22 +4272,23 @@ }, { "name": "friendsofphp/php-cs-fixer", - "version": "v3.92.2", + "version": "v3.95.1", "source": { "type": "git", "url": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer.git", - "reference": "64fab3553dce507ce247f7d1a7d65f74ef658c3f" + "reference": "a9727678fbd12997f1d9de8f4a37824ed9df1065" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHP-CS-Fixer/PHP-CS-Fixer/zipball/64fab3553dce507ce247f7d1a7d65f74ef658c3f", - "reference": "64fab3553dce507ce247f7d1a7d65f74ef658c3f", + "url": "https://api.github.com/repos/PHP-CS-Fixer/PHP-CS-Fixer/zipball/a9727678fbd12997f1d9de8f4a37824ed9df1065", + "reference": "a9727678fbd12997f1d9de8f4a37824ed9df1065", "shasum": "" }, "require": { "clue/ndjson-react": "^1.3", "composer/semver": "^3.4", "composer/xdebug-handler": "^3.0.5", + "ergebnis/agent-detector": "^1.1.1", "ext-filter": "*", "ext-hash": "*", "ext-json": "*", @@ -4104,7 +4299,7 @@ "react/event-loop": "^1.5", "react/socket": "^1.16", "react/stream": "^1.4", - "sebastian/diff": "^4.0.6 || ^5.1.1 || ^6.0.2 || ^7.0", + "sebastian/diff": "^4.0.6 || ^5.1.1 || ^6.0.2 || ^7.0 || ^8.0", "symfony/console": "^5.4.47 || ^6.4.24 || ^7.0 || ^8.0", "symfony/event-dispatcher": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0", "symfony/filesystem": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0", @@ -4118,18 +4313,18 @@ "symfony/stopwatch": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0" }, "require-dev": { - "facile-it/paraunit": "^1.3.1 || ^2.7", - "infection/infection": "^0.31.0", - "justinrainbow/json-schema": "^6.5", - "keradus/cli-executor": "^2.2", + "facile-it/paraunit": "^1.3.1 || ^2.8.0", + "infection/infection": "^0.32.6", + "justinrainbow/json-schema": "^6.8.0", + "keradus/cli-executor": "^2.3", "mikey179/vfsstream": "^1.6.12", - "php-coveralls/php-coveralls": "^2.9", - "php-cs-fixer/phpunit-constraint-isidenticalstring": "^1.6", - "php-cs-fixer/phpunit-constraint-xmlmatchesxsd": "^1.6", - "phpunit/phpunit": "^9.6.25 || ^10.5.53 || ^11.5.34", + "php-coveralls/php-coveralls": "^2.9.1", + "php-cs-fixer/phpunit-constraint-isidenticalstring": "^1.8", + "php-cs-fixer/phpunit-constraint-xmlmatchesxsd": "^1.8", + "phpunit/phpunit": "^9.6.34 || ^10.5.63 || ^11.5.55", "symfony/polyfill-php85": "^1.33", - "symfony/var-dumper": "^5.4.48 || ^6.4.24 || ^7.3.2 || ^8.0", - "symfony/yaml": "^5.4.45 || ^6.4.24 || ^7.3.2 || ^8.0" + "symfony/var-dumper": "^5.4.48 || ^6.4.32 || ^7.4.4 || ^8.0.8", + "symfony/yaml": "^5.4.45 || ^6.4.30 || ^7.4.1 || ^8.0.8" }, "suggest": { "ext-dom": "For handling output formats in XML", @@ -4170,7 +4365,7 @@ ], "support": { "issues": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues", - "source": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/tree/v3.92.2" + "source": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/tree/v3.95.1" }, "funding": [ { @@ -4178,20 +4373,20 @@ "type": "github" } ], - "time": "2025-12-17T00:04:16+00:00" + "time": "2026-04-12T17:00:09+00:00" }, { "name": "php-standard-library/phpstan-extension", - "version": "2.0.2", + "version": "2.1.0", "source": { "type": "git", "url": "https://github.com/php-standard-library/phpstan-extension.git", - "reference": "eaf787ddf91f1b22b3a4da052f42294e0a75836e" + "reference": "138b048577442500656cf3def6ff840ee918116f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-standard-library/phpstan-extension/zipball/eaf787ddf91f1b22b3a4da052f42294e0a75836e", - "reference": "eaf787ddf91f1b22b3a4da052f42294e0a75836e", + "url": "https://api.github.com/repos/php-standard-library/phpstan-extension/zipball/138b048577442500656cf3def6ff840ee918116f", + "reference": "138b048577442500656cf3def6ff840ee918116f", "shasum": "" }, "require": { @@ -4199,13 +4394,14 @@ "phpstan/phpstan": "^2.0" }, "conflict": { - "azjezz/psl": "<1.6||>=5.0" + "azjezz/psl": "*", + "php-standard-library/php-standard-library": "<1.6||>=7.0" }, "require-dev": { - "azjezz/psl": "^1.6||^2.0||^3.0||^4.0", "composer/semver": "^3.3", "nikic/php-parser": "^4.14.0", "php-parallel-lint/php-parallel-lint": "^1.2", + "php-standard-library/php-standard-library": "^1.6||^2.0||^3.0||^4.0||^5.0||^6.0", "phpstan/phpstan-phpunit": "^2.0", "phpstan/phpstan-strict-rules": "^2.0", "phpunit/phpunit": "^9.6" @@ -4230,22 +4426,22 @@ "description": "PHPStan PSL extension", "support": { "issues": "https://github.com/php-standard-library/phpstan-extension/issues", - "source": "https://github.com/php-standard-library/phpstan-extension/tree/2.0.2" + "source": "https://github.com/php-standard-library/phpstan-extension/tree/2.1.0" }, - "time": "2025-11-30T13:33:52+00:00" + "time": "2026-03-18T10:23:49+00:00" }, { "name": "php-stubs/wordpress-stubs", - "version": "v6.9.0", + "version": "v6.9.1", "source": { "type": "git", "url": "https://github.com/php-stubs/wordpress-stubs.git", - "reference": "5171cb6650e6c583a96943fd6ea0dfa3e1089a8a" + "reference": "f12220f303e0d7c0844c0e5e957b0c3cee48d2f7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-stubs/wordpress-stubs/zipball/5171cb6650e6c583a96943fd6ea0dfa3e1089a8a", - "reference": "5171cb6650e6c583a96943fd6ea0dfa3e1089a8a", + "url": "https://api.github.com/repos/php-stubs/wordpress-stubs/zipball/f12220f303e0d7c0844c0e5e957b0c3cee48d2f7", + "reference": "f12220f303e0d7c0844c0e5e957b0c3cee48d2f7", "shasum": "" }, "conflict": { @@ -4256,9 +4452,10 @@ "nikic/php-parser": "^5.5", "php": "^7.4 || ^8.0", "php-stubs/generator": "^0.8.3", - "phpdocumentor/reflection-docblock": "^5.4.1", + "phpdocumentor/reflection-docblock": "^6.0", "phpstan/phpstan": "^2.1", "phpunit/phpunit": "^9.5", + "symfony/polyfill-php80": "*", "szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset": "^1.1.1", "wp-coding-standards/wpcs": "3.1.0 as 2.3.0" }, @@ -4281,9 +4478,9 @@ ], "support": { "issues": "https://github.com/php-stubs/wordpress-stubs/issues", - "source": "https://github.com/php-stubs/wordpress-stubs/tree/v6.9.0" + "source": "https://github.com/php-stubs/wordpress-stubs/tree/v6.9.1" }, - "time": "2025-12-03T23:06:24+00:00" + "time": "2026-02-03T19:29:21+00:00" }, { "name": "phpstan/extension-installer", @@ -4335,11 +4532,11 @@ }, { "name": "phpstan/phpstan", - "version": "2.1.33", + "version": "2.1.54", "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpstan/phpstan/zipball/9e800e6bee7d5bd02784d4c6069b48032d16224f", - "reference": "9e800e6bee7d5bd02784d4c6069b48032d16224f", + "url": "https://api.github.com/repos/phpstan/phpstan/zipball/8be50c3992107dc837b17da4d140fbbdf9a5c5bd", + "reference": "8be50c3992107dc837b17da4d140fbbdf9a5c5bd", "shasum": "" }, "require": { @@ -4384,7 +4581,7 @@ "type": "github" } ], - "time": "2025-12-05T10:24:31+00:00" + "time": "2026-04-29T13:31:09+00:00" }, { "name": "psr/event-dispatcher", @@ -4560,16 +4757,16 @@ }, { "name": "react/child-process", - "version": "v0.6.6", + "version": "v0.6.7", "source": { "type": "git", "url": "https://github.com/reactphp/child-process.git", - "reference": "1721e2b93d89b745664353b9cfc8f155ba8a6159" + "reference": "970f0e71945556422ee4570ccbabaedc3cf04ad3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/reactphp/child-process/zipball/1721e2b93d89b745664353b9cfc8f155ba8a6159", - "reference": "1721e2b93d89b745664353b9cfc8f155ba8a6159", + "url": "https://api.github.com/repos/reactphp/child-process/zipball/970f0e71945556422ee4570ccbabaedc3cf04ad3", + "reference": "970f0e71945556422ee4570ccbabaedc3cf04ad3", "shasum": "" }, "require": { @@ -4623,7 +4820,7 @@ ], "support": { "issues": "https://github.com/reactphp/child-process/issues", - "source": "https://github.com/reactphp/child-process/tree/v0.6.6" + "source": "https://github.com/reactphp/child-process/tree/v0.6.7" }, "funding": [ { @@ -4631,7 +4828,7 @@ "type": "open_collective" } ], - "time": "2025-01-01T16:37:48+00:00" + "time": "2025-12-23T15:25:20+00:00" }, { "name": "react/dns", @@ -5012,84 +5209,24 @@ ], "time": "2024-06-11T12:45:25+00:00" }, - { - "name": "rector/rector", - "version": "2.2.14", - "source": { - "type": "git", - "url": "https://github.com/rectorphp/rector.git", - "reference": "6d56bb0e94d4df4f57a78610550ac76ab403657d" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/rectorphp/rector/zipball/6d56bb0e94d4df4f57a78610550ac76ab403657d", - "reference": "6d56bb0e94d4df4f57a78610550ac76ab403657d", - "shasum": "" - }, - "require": { - "php": "^7.4|^8.0", - "phpstan/phpstan": "^2.1.33" - }, - "conflict": { - "rector/rector-doctrine": "*", - "rector/rector-downgrade-php": "*", - "rector/rector-phpunit": "*", - "rector/rector-symfony": "*" - }, - "suggest": { - "ext-dom": "To manipulate phpunit.xml via the custom-rule command" - }, - "bin": [ - "bin/rector" - ], - "type": "library", - "autoload": { - "files": [ - "bootstrap.php" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "description": "Instant Upgrade and Automated Refactoring of any PHP code", - "homepage": "https://getrector.com/", - "keywords": [ - "automation", - "dev", - "migration", - "refactoring" - ], - "support": { - "issues": "https://github.com/rectorphp/rector/issues", - "source": "https://github.com/rectorphp/rector/tree/2.2.14" - }, - "funding": [ - { - "url": "https://github.com/tomasvotruba", - "type": "github" - } - ], - "time": "2025-12-09T10:57:55+00:00" - }, { "name": "roave/security-advisories", "version": "dev-latest", "source": { "type": "git", "url": "https://github.com/Roave/SecurityAdvisories.git", - "reference": "df7a11b7df806e493d3047bf9cf9736645bbdf84" + "reference": "2221f6ef09e87784e78e188aadd8f7e3a50e679a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Roave/SecurityAdvisories/zipball/df7a11b7df806e493d3047bf9cf9736645bbdf84", - "reference": "df7a11b7df806e493d3047bf9cf9736645bbdf84", + "url": "https://api.github.com/repos/Roave/SecurityAdvisories/zipball/2221f6ef09e87784e78e188aadd8f7e3a50e679a", + "reference": "2221f6ef09e87784e78e188aadd8f7e3a50e679a", "shasum": "" }, "conflict": { "3f/pygmentize": "<1.2", "adaptcms/adaptcms": "<=1.3", - "admidio/admidio": "<=4.3.16", + "admidio/admidio": "<=5.0.8", "adodb/adodb-php": "<=5.22.9", "aheinze/cockpit": "<2.2", "aimeos/ai-admin-graphql": ">=2022.04.1,<2022.10.10|>=2023.04.1,<2023.10.6|>=2024.04.1,<2024.07.2", @@ -5098,12 +5235,15 @@ "aimeos/ai-cms-grapesjs": ">=2021.04.1,<2021.10.8|>=2022.04.1,<2022.10.9|>=2023.04.1,<2023.10.15|>=2024.04.1,<2024.10.8|>=2025.04.1,<2025.10.2", "aimeos/ai-controller-frontend": "<2020.10.15|>=2021.04.1,<2021.10.8|>=2022.04.1,<2022.10.8|>=2023.04.1,<2023.10.9|==2024.04.1", "aimeos/aimeos-core": ">=2022.04.1,<2022.10.17|>=2023.04.1,<2023.10.17|>=2024.04.1,<2024.04.7", + "aimeos/aimeos-laravel": "==2021.10", "aimeos/aimeos-typo3": "<19.10.12|>=20,<20.10.5", "airesvsg/acf-to-rest-api": "<=3.1", "akaunting/akaunting": "<2.1.13", "akeneo/pim-community-dev": "<5.0.119|>=6,<6.0.53", - "alextselegidis/easyappointments": "<1.5.2.0-beta1", + "alextselegidis/easyappointments": "<=1.5.2", "alexusmai/laravel-file-manager": "<=3.3.1", + "algolia/algoliasearch-magento-2": "<=3.16.1|>=3.17.0.0-beta1,<=3.17.1", + "almirhodzic/nova-toggle-5": "<1.3", "alt-design/alt-redirect": "<1.6.4", "altcha-org/altcha": "<1.3.1", "alterphp/easyadmin-extension-bundle": ">=1.2,<1.2.11|>=1.3,<1.3.1", @@ -5112,6 +5252,7 @@ "amphp/artax": "<1.0.6|>=2,<2.0.6", "amphp/http": "<=1.7.2|>=2,<=2.1", "amphp/http-client": ">=4,<4.4", + "amphp/http-server": ">=2.0.0.0-RC1-dev,<2.1.10|>=3.0.0.0-beta1,<3.4.4", "anchorcms/anchor-cms": "<=0.12.7", "andreapollastri/cipi": "<=3.1.15", "andrewhaine/silverstripe-form-capture": ">=0.2,<=0.2.3|>=1,<1.0.2|>=2,<2.2.5", @@ -5128,28 +5269,30 @@ "athlon1600/php-proxy": "<=5.1", "athlon1600/php-proxy-app": "<=3", "athlon1600/youtube-downloader": "<=4", + "aureuserp/aureuserp": "<1.3.0.0-beta1", "austintoddj/canvas": "<=3.4.2", - "auth0/auth0-php": ">=3.3,<=8.16", - "auth0/login": "<=7.18", - "auth0/symfony": "<=5.4.1", - "auth0/wordpress": "<=5.3", + "auth0/auth0-php": ">=3.3,<=8.18", + "auth0/login": "<=7.20", + "auth0/symfony": "<=5.7", + "auth0/wordpress": "<=5.5", "automad/automad": "<2.0.0.0-alpha5", "automattic/jetpack": "<9.8", "awesome-support/awesome-support": "<=6.0.7", - "aws/aws-sdk-php": "<3.288.1", - "azuracast/azuracast": "<=0.23.1", + "aws/aws-sdk-php": "<=3.371.3", + "ayacoo/redirect-tab": "<2.1.2|>=3,<3.1.7|>=4,<4.0.5", + "azuracast/azuracast": "<=0.23.3", "b13/seo_basics": "<0.8.2", "backdrop/backdrop": "<=1.32", "backpack/crud": "<3.4.9", "backpack/filemanager": "<2.0.2|>=3,<3.0.9", "bacula-web/bacula-web": "<9.7.1", "badaso/core": "<=2.9.11", - "bagisto/bagisto": "<=2.3.7", + "bagisto/bagisto": "<2.3.10", "barrelstrength/sprout-base-email": "<1.2.7", "barrelstrength/sprout-forms": "<3.9", "barryvdh/laravel-translation-manager": "<0.6.8", "barzahlen/barzahlen-php": "<2.0.1", - "baserproject/basercms": "<=5.1.1", + "baserproject/basercms": "<=5.2.2", "bassjobsen/bootstrap-3-typeahead": ">4.0.2", "bbpress/bbpress": "<2.6.5", "bcit-ci/codeigniter": "<3.1.3", @@ -5176,7 +5319,8 @@ "bvbmedia/multishop": "<2.0.39", "bytefury/crater": "<6.0.2", "cachethq/cachet": "<2.5.1", - "cakephp/cakephp": "<3.10.3|>=4,<4.0.10|>=4.1,<4.1.4|>=4.2,<4.2.12|>=4.3,<4.3.11|>=4.4,<4.4.10", + "cadmium-org/cadmium-cms": "<=0.4.9", + "cakephp/cakephp": "<3.10.3|>=4,<4.0.10|>=4.1,<4.1.4|>=4.2,<4.2.12|>=4.3,<4.3.11|>=4.4,<4.4.10|>=5.2.10,<5.2.12|==5.3", "cakephp/database": ">=4.2,<4.2.12|>=4.3,<4.3.11|>=4.4,<4.4.10", "cardgate/magento2": "<2.0.33", "cardgate/woocommerce": "<=3.1.15", @@ -5187,15 +5331,17 @@ "causal/oidc": "<4", "cecil/cecil": "<7.47.1", "centreon/centreon": "<22.10.15", + "cesargb/laravel-magiclink": ">=2,<2.25.1", "cesnet/simplesamlphp-module-proxystatistics": "<3.1", "chriskacerguis/codeigniter-restserver": "<=2.7.1", "chrome-php/chrome": "<1.14", + "ci4-cms-erp/ci4ms": "<=0.31.6", "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", "co-stack/fal_sftp": "<0.2.6", - "cockpit-hq/cockpit": "<2.11.4", - "code16/sharp": "<9.11.1", + "cockpit-hq/cockpit": "<2.14", + "code16/sharp": "<9.20", "codeception/codeception": "<3.1.3|>=4,<4.1.22", "codeigniter/framework": "<3.1.10", "codeigniter4/framework": "<4.6.2", @@ -5205,8 +5351,8 @@ "codingms/modules": "<4.3.11|>=5,<5.7.4|>=6,<6.4.2|>=7,<7.5.5", "commerceteam/commerce": ">=0.9.6,<0.9.9", "components/jquery": ">=1.0.3,<3.5", - "composer/composer": "<1.10.27|>=2,<2.2.24|>=2.3,<2.7.7", - "concrete5/concrete5": "<9.4.3", + "composer/composer": "<2.2.27|>=2.3,<2.9.6", + "concrete5/concrete5": "<9.4.8", "concrete5/core": "<8.5.8|>=9,<9.1", "contao-components/mediaelement": ">=2.14.2,<2.21.1", "contao/comments-bundle": ">=2,<4.13.40|>=5.0.0.0-RC1-dev,<5.3.4", @@ -5215,11 +5361,20 @@ "contao/core-bundle": "<4.13.57|>=5,<5.3.42|>=5.4,<5.6.5", "contao/listing-bundle": ">=3,<=3.5.30|>=4,<4.4.8", "contao/managed-edition": "<=1.5", + "coreshop/core-shop": "<4.1.9", "corveda/phpsandbox": "<1.3.5", "cosenary/instagram": "<=2.3", "couleurcitron/tarteaucitron-wp": "<0.3", - "craftcms/cms": "<=4.16.5|>=5,<=5.8.6", - "croogo/croogo": "<4", + "cpsit/typo3-mailqueue": "<0.4.5|>=0.5,<0.5.2", + "craftcms/aws-s3": ">=2.0.2,<=2.2.4", + "craftcms/azure-blob": ">=2.0.0.0-beta1,<=2.1", + "craftcms/cms": "<=4.17.8|>=5,<5.9.15", + "craftcms/commerce": ">=4,<4.11|>=5,<5.6", + "craftcms/composer": ">=4.0.0.0-RC1-dev,<=4.10|>=5.0.0.0-RC1-dev,<=5.5.1", + "craftcms/craft": ">=3.5,<=4.16.17|>=5.0.0.0-RC1-dev,<=5.8.21", + "craftcms/google-cloud": ">=2.0.0.0-beta1,<=2.2", + "craftcms/webhooks": ">=3,<3.2", + "croogo/croogo": "<=4.0.7", "cuyz/valinor": "<0.12", "czim/file-handling": "<1.5|>=2,<2.3", "czproject/git-php": "<4.0.3", @@ -5236,10 +5391,11 @@ "derhansen/sf_event_mgt": "<4.3.1|>=5,<5.1.1|>=7,<7.4", "desperado/xml-bundle": "<=0.1.7", "dev-lancer/minecraft-motd-parser": "<=1.0.5", - "devcode-it/openstamanager": "<=2.9.4", + "devcode-it/openstamanager": "<=2.10.1", "devgroup/dotplant": "<2020.09.14-dev", "digimix/wp-svg-upload": "<=1", "directmailteam/direct-mail": "<6.0.3|>=7,<7.0.3|>=8,<9.5.2", + "directorytree/imapengine": "<1.22.3", "dl/yag": "<3.0.1", "dmk/webkitpdf": "<1.1.4", "dnadesign/silverstripe-elemental": "<5.3.12", @@ -5252,9 +5408,10 @@ "doctrine/mongodb-odm": "<1.0.2", "doctrine/mongodb-odm-bundle": "<3.0.1", "doctrine/orm": ">=1,<1.2.4|>=2,<2.4.8|>=2.5,<2.5.1|>=2.8.3,<2.8.4", - "dolibarr/dolibarr": "<21.0.3", + "dolibarr/dolibarr": "<=22.0.4", "dompdf/dompdf": "<2.0.4", "doublethreedigital/guest-entries": "<3.1.2", + "dreamfactory/df-core": "<1.0.4", "drupal-pattern-lab/unified-twig-extensions": "<=0.1", "drupal/access_code": "<2.0.5", "drupal/acquia_dam": "<1.1.5", @@ -5266,7 +5423,7 @@ "drupal/commerce_alphabank_redirect": "<1.0.3", "drupal/commerce_eurobank_redirect": "<2.1.1", "drupal/config_split": "<1.10|>=2,<2.0.2", - "drupal/core": ">=6,<6.38|>=7,<7.102|>=8,<10.4.9|>=10.5,<10.5.6|>=11,<11.1.9|>=11.2,<11.2.8", + "drupal/core": ">=6,<6.38|>=7,<7.103|>=8,<10.4.9|>=10.5,<10.5.6|>=11,<11.1.9|>=11.2,<11.2.8", "drupal/core-recommended": ">=7,<7.102|>=8,<10.2.11|>=10.3,<10.3.9|>=11,<11.0.8", "drupal/currency": "<3.5", "drupal/drupal": ">=5,<5.11|>=6,<6.38|>=7,<7.102|>=8,<10.2.11|>=10.3,<10.3.9|>=11,<11.0.8", @@ -5293,10 +5450,10 @@ "drupal/umami_analytics": "<1.0.1", "duncanmcclean/guest-entries": "<3.1.2", "dweeves/magmi": "<=0.7.24", - "ec-cube/ec-cube": "<2.4.4|>=2.11,<=2.17.1|>=3,<=3.0.18.0-patch4|>=4,<=4.1.2", + "ec-cube/ec-cube": "<2.4.4|>=2.11,<=2.17.1|>=3,<=3.0.18.0-patch4|>=4,<=4.3.1", "ecodev/newsletter": "<=4", "ectouch/ectouch": "<=2.7.2", - "egroupware/egroupware": "<23.1.20240624", + "egroupware/egroupware": "<23.1.20260113|>=26.0.20251208,<26.0.20260113", "elefant/cms": "<2.0.7", "elgg/elgg": "<3.3.24|>=4,<4.0.5", "elijaa/phpmemcacheadmin": "<=1.3", @@ -5319,18 +5476,18 @@ "ezsystems/ezplatform-admin-ui-assets": ">=4,<4.2.1|>=5,<5.0.1|>=5.1,<5.1.1|>=5.3.0.0-beta1,<5.3.5", "ezsystems/ezplatform-graphql": ">=1.0.0.0-RC1-dev,<1.0.13|>=2.0.0.0-beta1,<2.3.12", "ezsystems/ezplatform-http-cache": "<2.3.16", - "ezsystems/ezplatform-kernel": "<1.2.5.1-dev|>=1.3,<1.3.35", + "ezsystems/ezplatform-kernel": "<=1.2.5|>=1.3,<1.3.35", "ezsystems/ezplatform-rest": ">=1.2,<=1.2.2|>=1.3,<1.3.8", "ezsystems/ezplatform-richtext": ">=2.3,<2.3.26|>=3.3,<3.3.40", "ezsystems/ezplatform-solr-search-engine": ">=1.7,<1.7.12|>=2,<2.0.2|>=3.3,<3.3.15", "ezsystems/ezplatform-user": ">=1,<1.0.1", - "ezsystems/ezpublish-kernel": "<6.13.8.2-dev|>=7,<7.5.31", + "ezsystems/ezpublish-kernel": "<=6.13.8.1|>=7,<7.5.31", "ezsystems/ezpublish-legacy": "<=2017.12.7.3|>=2018.6,<=2019.03.5.1", "ezsystems/platform-ui-assets-bundle": ">=4.2,<4.2.3", "ezsystems/repository-forms": ">=2.3,<2.3.2.1-dev|>=2.5,<2.5.15", "ezyang/htmlpurifier": "<=4.2", "facade/ignition": "<1.16.15|>=2,<2.4.2|>=2.5,<2.5.2", - "facturascripts/facturascripts": "<=2022.08", + "facturascripts/facturascripts": "<2025.81", "fastly/magento2": "<1.2.26", "feehi/cms": "<=2.1.1", "feehi/feehicms": "<=2.1.1", @@ -5338,18 +5495,19 @@ "filament/actions": ">=3.2,<3.2.123", "filament/filament": ">=4,<4.3.1", "filament/infolists": ">=3,<3.2.115", - "filament/tables": ">=3,<3.2.115", + "filament/tables": ">=3,<3.2.115|>=4,<4.8.5|>=5,<5.3.5", "filegator/filegator": "<7.8", "filp/whoops": "<2.1.13", "fineuploader/php-traditional-server": "<=1.2.2", - "firebase/php-jwt": "<6", + "firebase/php-jwt": "<7", "fisharebest/webtrees": "<=2.1.18", "fixpunkt/fp-masterquiz": "<2.2.1|>=3,<3.5.2", "fixpunkt/fp-newsletter": "<1.1.1|>=1.2,<2.1.2|>=2.2,<3.2.6", - "flarum/core": "<1.8.10", + "flarum/core": "<=1.8.15|>=2.0.0.0-beta1,<=2.0.0.0-beta8", "flarum/flarum": "<0.1.0.0-beta8", "flarum/framework": "<1.8.10", "flarum/mentions": "<1.6.3", + "flarum/nicknames": "<1.8.3", "flarum/sticky": ">=0.1.0.0-beta14,<=0.1.0.0-beta15", "flarum/tags": "<=0.1.0.0-beta13", "floriangaerber/magnesium": "<0.3.1", @@ -5371,17 +5529,18 @@ "friendsoftypo3/mediace": ">=7.6.2,<7.6.5", "friendsoftypo3/openid": ">=4.5,<4.5.31|>=4.7,<4.7.16|>=6,<6.0.11|>=6.1,<6.1.6", "froala/wysiwyg-editor": "<=4.3", - "froxlor/froxlor": "<=2.2.5", + "frosh/adminer-platform": "<2.2.1", + "froxlor/froxlor": "<2.3.6", "frozennode/administrator": "<=5.0.12", "fuel/core": "<1.8.1", - "funadmin/funadmin": "<=5.0.2", + "funadmin/funadmin": "<=7.1.0.0-RC4", "gaoming13/wechat-php-sdk": "<=1.10.2", "genix/cms": "<=1.1.11", "georgringer/news": "<1.3.3", "geshi/geshi": "<=1.0.9.1", - "getformwork/formwork": "<2.2", + "getformwork/formwork": "<=2.3.3", "getgrav/grav": "<1.11.0.0-beta1", - "getkirby/cms": "<3.9.8.3-dev|>=3.10,<3.10.1.2-dev|>=4,<4.7.1|>=5,<5.1.4", + "getkirby/cms": "<4.9|>=5,<5.4", "getkirby/kirby": "<3.9.8.3-dev|>=3.10,<3.10.1.2-dev|>=4,<4.7.1", "getkirby/panel": "<2.5.14", "getkirby/starterkit": "<=3.7.0.2", @@ -5390,12 +5549,13 @@ "globalpayments/php-sdk": "<2", "goalgorilla/open_social": "<12.3.11|>=12.4,<12.4.10|>=13.0.0.0-alpha1,<13.0.0.0-alpha11", "gogentooss/samlbase": "<1.2.7", - "google/protobuf": "<3.4", + "goodoneuz/pay-uz": "<=2.2.24", + "google/protobuf": "<4.33.6", "gos/web-socket-bundle": "<1.10.4|>=2,<2.6.1|>=3,<3.3", "gp247/core": "<1.1.24", "gree/jose": "<2.2.1", "gregwar/rst": "<1.0.3", - "grumpydictator/firefly-iii": "<6.1.17", + "grumpydictator/firefly-iii": "<6.1.17|>=6.4.23,<=6.5", "gugoan/economizzer": "<=0.9.0.0-beta1", "guzzlehttp/guzzle": "<6.5.8|>=7,<7.4.5", "guzzlehttp/oauth-subscriber": "<0.8.1", @@ -5410,6 +5570,7 @@ "hjue/justwriting": "<=1", "hov/jobfair": "<1.0.13|>=2,<2.0.2", "httpsoft/http-message": "<1.0.12", + "hybridauth/hybridauth": "<=3.12.2", "hyn/multi-tenant": ">=5.6,<5.7.2", "ibexa/admin-ui": ">=4.2,<4.2.3|>=4.6,<4.6.25|>=5,<5.0.3", "ibexa/admin-ui-assets": ">=4.6.0.0-alpha1,<4.6.21", @@ -5421,7 +5582,7 @@ "ibexa/solr": ">=4.5,<4.5.4", "ibexa/user": ">=4,<4.4.3|>=5,<5.0.4", "icecoder/icecoder": "<=8.1", - "idno/known": "<=1.3.1", + "idno/known": "<1.6.4", "ilicmiljan/secure-props": ">=1.2,<1.2.2", "illuminate/auth": "<5.5.10", "illuminate/cookie": ">=4,<=4.0.11|>=4.1,<6.18.31|>=7,<7.22.4", @@ -5438,10 +5599,12 @@ "innologi/typo3-appointments": "<2.0.6", "intelliants/subrion": "<4.2.2", "inter-mediator/inter-mediator": "==5.5", - "ipl/web": "<0.10.1", + "invoiceninja/invoiceninja": "<5.13.4", + "ipl/web": "<=0.13", "islandora/crayfish": "<4.1", "islandora/islandora": ">=2,<2.4.1", "ivankristianto/phpwhois": "<=4.3", + "j0k3r/graby": "<=2.5", "jackalope/jackalope-doctrine-dbal": "<1.7.4", "jambagecom/div2007": "<0.10.2", "james-heinrich/getid3": "<1.9.21", @@ -5449,7 +5612,9 @@ "jasig/phpcas": "<1.3.3", "jbartels/wec-map": "<3.0.3", "jcbrand/converse.js": "<3.3.3", + "joedolson/my-calendar": "<3.7.7", "joelbutcher/socialstream": "<5.6|>=6,<6.2", + "johnbillion/query-monitor": "<3.20.4", "johnbillion/wp-crontrol": "<1.16.2|>=1.17,<1.19.2", "joomla/application": "<1.0.13", "joomla/archive": "<1.1.12|>=2,<2.0.1", @@ -5467,17 +5632,19 @@ "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", "kevinpapst/kimai2": "<1.16.7", - "khodakhah/nodcms": "<=3", - "kimai/kimai": "<=2.20.1", + "khodakhah/nodcms": "<=3.4.1", + "kimai/kimai": "<2.54", "kitodo/presentation": "<3.2.3|>=3.3,<3.3.4", "klaviyo/magento2-extension": ">=1,<3", "knplabs/knp-snappy": "<=1.4.2", "kohana/core": "<3.3.3", "koillection/koillection": "<1.6.12", - "krayin/laravel-crm": "<=1.3", + "krayin/laravel-crm": "<=2.2", "kreait/firebase-php": ">=3.2,<3.8.1", "kumbiaphp/kumbiapp": "<=1.1.1", "la-haute-societe/tcpdf": "<6.2.22", @@ -5489,24 +5656,26 @@ "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,<13.7.1", "laravel/pulse": "<1.3.1", - "laravel/reverb": "<1.4", + "laravel/reverb": "<1.7", "laravel/socialite": ">=1,<2.0.10", "latte/latte": "<2.10.8", - "lavalite/cms": "<=9|==10.1", + "lavalite/cms": "<=10.1", "lavitto/typo3-form-to-database": "<2.2.5|>=3,<3.2.2|>=4,<4.2.3|>=5,<5.0.2", "lcobucci/jwt": ">=3.4,<3.4.6|>=4,<4.0.4|>=4.1,<4.1.5", - "league/commonmark": "<2.7", + "league/commonmark": "<=2.8.1", "league/flysystem": "<1.1.4|>=2,<2.1.1", "league/oauth2-server": ">=8.3.2,<8.4.2|>=8.5,<8.5.3", "leantime/leantime": "<3.3", "lexik/jwt-authentication-bundle": "<2.10.7|>=2.11,<2.11.3", "libreform/libreform": ">=2,<=2.0.8", - "librenms/librenms": "<25.11", + "librenms/librenms": "<26.3", "liftkit/database": "<2.13.2", "lightsaml/lightsaml": "<1.3.5", - "limesurvey/limesurvey": "<6.5.12", + "limesurvey/limesurvey": "<6.15.4", "livehelperchat/livehelperchat": "<=3.91", + "livewire-filemanager/filemanager": "<=1.0.4", "livewire/livewire": "<2.12.7|>=3.0.0.0-beta1,<3.6.4", "livewire/volt": "<1.7", "lms/routes": "<2.1.1", @@ -5527,12 +5696,13 @@ "maikuolan/phpmussel": ">=1,<1.6", "mainwp/mainwp": "<=4.4.3.3", "manogi/nova-tiptap": "<=3.2.6", - "mantisbt/mantisbt": "<2.27.2", + "mantisbt/mantisbt": "<2.28.1", "marcwillmann/turn": "<0.3.3", + "markhuot/craftql": "<=1.3.7", "marshmallow/nova-tiptap": "<5.7", "matomo/matomo": "<1.11", "matyhtf/framework": "<3.0.6", - "mautic/core": "<5.2.9|>=6,<6.0.7", + "mautic/core": "<5.2.10|>=6,<6.0.8|>=7.0.0.0-alpha,<7.0.1", "mautic/core-lib": ">=1.0.0.0-beta,<4.4.13|>=5.0.0.0-alpha,<5.1.1", "mautic/grapes-js-builder-bundle": ">=4,<4.4.18|>=5,<5.2.9|>=6,<6.0.7", "maximebf/debugbar": "<1.19", @@ -5554,10 +5724,11 @@ "microsoft/microsoft-graph": ">=1.16,<1.109.1|>=2,<2.0.1", "microsoft/microsoft-graph-beta": "<2.0.1", "microsoft/microsoft-graph-core": "<2.0.2", - "microweber/microweber": "<=2.0.19", + "microweber/microweber": "<2.0.20", "mikehaertl/php-shellcommand": "<1.6.1", "mineadmin/mineadmin": "<=3.0.9", "miniorange/miniorange-saml": "<1.4.3", + "miraheze/ts-portal": "<=33", "mittwald/typo3_forum": "<1.2.1", "mobiledetect/mobiledetectlib": "<2.8.32", "modx/revolution": "<=3.1", @@ -5565,7 +5736,7 @@ "mongodb/mongodb": ">=1,<1.9.2", "mongodb/mongodb-extension": "<1.21.2", "monolog/monolog": ">=1.8,<1.12", - "moodle/moodle": "<4.4.11|>=4.5.0.0-beta,<4.5.7|>=5.0.0.0-beta,<5.0.3", + "moodle/moodle": "<4.5.9|>=5.0.0.0-beta,<5.0.5|>=5.1.0.0-beta,<5.1.2", "moonshine/moonshine": "<=3.12.5", "mos/cimage": "<0.7.19", "movim/moxl": ">=0.8,<=0.10", @@ -5608,9 +5779,9 @@ "nzo/url-encryptor-bundle": ">=4,<4.3.2|>=5,<5.0.1", "october/backend": "<1.1.2", "october/cms": "<1.0.469|==1.0.469|==1.0.471|==1.1.1", - "october/october": "<3.7.5", - "october/rain": "<1.0.472|>=1.1,<1.1.2", - "october/system": "<3.7.5", + "october/october": "<3.7.14|>=4,<4.1.10", + "october/rain": "<=3.7.13|>=4,<=4.1.9", + "october/system": "<3.7.16|>=4,<4.1.16", "oliverklee/phpunit": "<3.5.15", "omeka/omeka-s": "<4.0.3", "onelogin/php-saml": "<2.21.1|>=3,<3.8.1|>=4,<4.3.1", @@ -5618,9 +5789,9 @@ "open-web-analytics/open-web-analytics": "<1.8.1", "opencart/opencart": ">=0", "openid/php-openid": "<2.3", - "openmage/magento-lts": "<20.16", + "openmage/magento-lts": "<20.17", "opensolutions/vimbadmin": "<=3.0.15", - "opensource-workshop/connect-cms": "<1.8.7|>=2,<2.4.7", + "opensource-workshop/connect-cms": "<1.41.1|>=2,<2.41.1", "orchid/platform": ">=8,<14.43", "oro/calendar-bundle": ">=4.2,<=4.2.6|>=5,<=5.0.6|>=5.1,<5.1.1", "oro/commerce": ">=4.1,<5.0.11|>=5.1,<5.1.1", @@ -5637,6 +5808,7 @@ "pagekit/pagekit": "<=1.0.18", "paragonie/ecc": "<2.0.1", "paragonie/random_compat": "<2", + "paragonie/sodium_compat": "<1.24|>=2,<2.5", "passbolt/passbolt_api": "<4.6.2", "paypal/adaptivepayments-sdk-php": "<=3.9.2", "paypal/invoice-sdk-php": "<=3.9", @@ -5649,6 +5821,7 @@ "pear/pear": "<=1.10.1", "pegasus/google-for-jobs": "<1.5.1|>=2,<2.1.1", "personnummer/personnummer": "<3.0.2", + "ph7software/ph7builder": "<=17.9.1", "phanan/koel": "<5.1.4", "phenx/php-svg-lib": "<0.5.2", "php-censor/php-censor": "<2.0.13|>=2.1,<2.1.5", @@ -5659,33 +5832,35 @@ "phpmailer/phpmailer": "<6.5", "phpmussel/phpmussel": ">=1,<1.6", "phpmyadmin/phpmyadmin": "<5.2.2", - "phpmyfaq/phpmyfaq": "<=4.0.13", + "phpmyfaq/phpmyfaq": "<=4.1", "phpoffice/common": "<0.2.9", "phpoffice/math": "<=0.2", "phpoffice/phpexcel": "<=1.8.2", - "phpoffice/phpspreadsheet": "<1.30|>=2,<2.1.12|>=2.2,<2.4|>=3,<3.10|>=4,<5", + "phpoffice/phpspreadsheet": "<=1.30.3|>=2,<=2.1.15|>=2.2,<=2.4.4|>=3,<=3.10.4|>=4,<=5.6", "phppgadmin/phppgadmin": "<=7.13", - "phpseclib/phpseclib": "<2.0.47|>=3,<3.0.36", + "phpseclib/phpseclib": "<2.0.53|>=3,<3.0.51", "phpservermon/phpservermon": "<3.6", "phpsysinfo/phpsysinfo": "<3.4.3", - "phpunit/phpunit": ">=4.8.19,<4.8.28|>=5.0.10,<5.6.3", + "phpunit/phpunit": "<8.5.52|>=9,<9.6.33|>=10,<10.5.62|>=11,<11.5.50|>=12,<12.5.8|>=12.5.21,<12.5.22|>=13.1.5,<13.1.6", "phpwhois/phpwhois": "<=4.2.5", "phpxmlrpc/extras": "<0.6.1", "phpxmlrpc/phpxmlrpc": "<4.9.2", + "phraseanet/phraseanet": "==4.0.3", "pi/pi": "<=2.5", - "pimcore/admin-ui-classic-bundle": "<1.7.6", + "pimcore/admin-ui-classic-bundle": "<=1.7.15|>=2.0.0.0-RC1-dev,<=2.2.2", "pimcore/customer-management-framework-bundle": "<4.2.1", "pimcore/data-hub": "<1.2.4", "pimcore/data-importer": "<1.8.9|>=1.9,<1.9.3", "pimcore/demo": "<10.3", "pimcore/ecommerce-framework-bundle": "<1.0.10", "pimcore/perspective-editor": "<1.5.1", - "pimcore/pimcore": "<11.5.4", + "pimcore/pimcore": "<=11.5.14.1|>=12,<12.3.3", + "pimcore/web2print-tools-bundle": "<=5.2.1|>=6.0.0.0-RC1-dev,<=6.1", "piwik/piwik": "<1.11", "pixelfed/pixelfed": "<0.12.5", "plotly/plotly.js": "<2.25.2", "pocketmine/bedrock-protocol": "<8.0.2", - "pocketmine/pocketmine-mp": "<5.32.1", + "pocketmine/pocketmine-mp": "<5.42.1", "pocketmine/raklib": ">=0.14,<0.14.6|>=0.15,<0.15.1", "pressbooks/pressbooks": "<5.18", "prestashop/autoupgrade": ">=4,<4.10.1", @@ -5693,23 +5868,25 @@ "prestashop/blockwishlist": ">=2,<2.1.1", "prestashop/contactform": ">=1.0.1,<4.3", "prestashop/gamification": "<2.3.2", - "prestashop/prestashop": "<8.2.3", + "prestashop/prestashop": "<8.2.5|>=9.0.0.0-alpha1,<9.1", "prestashop/productcomments": "<5.0.2", - "prestashop/ps_checkout": "<4.4.1|>=5,<5.0.5", + "prestashop/ps_checkout": "<5.3", "prestashop/ps_contactinfo": "<=3.3.2", "prestashop/ps_emailsubscription": "<2.6.1", "prestashop/ps_facetedsearch": "<3.4.1", "prestashop/ps_linklist": "<3.1", "privatebin/privatebin": "<1.4|>=1.5,<1.7.4|>=1.7.7,<2.0.3", - "processwire/processwire": "<=3.0.246", + "processwire/processwire": "<=3.0.255", "propel/propel": ">=2.0.0.0-alpha1,<=2.0.0.0-alpha7", "propel/propel1": ">=1,<=1.7.1", - "pterodactyl/panel": "<=1.11.10", + "psy/psysh": "<=0.11.22|>=0.12,<=0.12.18", + "pterodactyl/panel": "<1.12.1", "ptheofan/yii2-statemachine": ">=2.0.0.0-RC1-dev,<=2", "ptrofimov/beanstalk_console": "<1.7.14", "pubnub/pubnub": "<6.1", "punktde/pt_extbase": "<1.5.1", "pusher/pusher-php-server": "<2.2.1", + "putyourlightson/craft-sprig": ">=2,<2.15.2|>=3,<3.7.2", "pwweb/laravel-core": "<=0.3.6.0-beta", "pxlrbt/filament-excel": "<1.1.14|>=2.0.0.0-alpha,<2.3.3", "pyrocms/pyrocms": "<=3.9.1", @@ -5718,25 +5895,30 @@ "rainlab/blog-plugin": "<1.4.1", "rainlab/debugbar-plugin": "<3.1", "rainlab/user-plugin": "<=1.4.5", + "ralffreit/mfa-email": "<1.0.7|==2", "rankmath/seo-by-rank-math": "<=1.0.95", "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", - "robrichards/xmlseclibs": "<=3.1.3", + "roadiz/documents": "<2.3.42|>=2.4,<2.5.44|>=2.6,<2.6.28|>=2.7,<2.7.9", + "roadiz/openid": "<2.3.43|>=2.5,<2.5.45|>=2.6,<2.6.31|>=2.7,<2.7.18", + "robrichards/xmlseclibs": "<3.1.5", "roots/soil": "<4.1", - "roundcube/roundcubemail": "<1.5.10|>=1.6,<1.6.11", + "roundcube/roundcubemail": "<1.5.10|>=1.6,<1.6.11|>=1.7.0.0-beta,<1.7.0.0-RC5-dev", "rudloff/alltube": "<3.0.3", "rudloff/rtmpdump-bin": "<=2.3.1", "s-cart/core": "<=9.0.5", "s-cart/s-cart": "<6.9", + "s9y/serendipity": "<2.6", "sabberworm/php-css-parser": ">=1,<1.0.1|>=2,<2.0.1|>=3,<3.0.1|>=4,<4.0.1|>=5,<5.0.9|>=5.1,<5.1.3|>=5.2,<5.2.1|>=6,<6.0.2|>=7,<7.0.4|>=8,<8.0.1|>=8.1,<8.1.1|>=8.2,<8.2.1|>=8.3,<8.3.1", "sabre/dav": ">=1.6,<1.7.11|>=1.8,<1.8.9", + "saloonphp/saloon": "<4", "samwilson/unlinked-wikibase": "<1.42", "scheb/two-factor-bundle": "<3.26|>=4,<4.11", "sensiolabs/connect": "<4.2.3", @@ -5744,17 +5926,17 @@ "setasign/fpdi": "<2.6.4", "sfroemken/url_redirect": "<=1.2.1", "sheng/yiicms": "<1.2.1", - "shopware/core": "<6.6.10.9-dev|>=6.7,<6.7.4.1-dev", - "shopware/platform": "<6.6.10.7-dev|>=6.7,<6.7.3.1-dev", + "shopware/core": "<6.6.10.15-dev|>=6.7,<6.7.8.1-dev", + "shopware/platform": "<6.6.10.15-dev|>=6.7,<6.7.8.1-dev", "shopware/production": "<=6.3.5.2", - "shopware/shopware": "<=5.7.17|>=6.4.6,<6.6.10.10-dev|>=6.7,<6.7.5.1-dev", + "shopware/shopware": "<=5.7.17|>=6.4.6,<6.6.10.10-dev|>=6.7,<6.7.6.1-dev", "shopware/storefront": "<6.6.10.10-dev|>=6.7,<6.7.5.1-dev", "shopxo/shopxo": "<=6.4", "showdoc/showdoc": "<2.10.4", "shuchkin/simplexlsx": ">=1.0.12,<1.1.13", "silverstripe-australia/advancedreports": ">=1,<=2", "silverstripe/admin": "<1.13.19|>=2,<2.1.8", - "silverstripe/assets": ">=1,<1.11.1", + "silverstripe/assets": "<2.4.5|>=3,<3.1.3", "silverstripe/cms": "<4.11.3", "silverstripe/comments": ">=1.3,<3.1.1", "silverstripe/forum": "<=0.6.1|>=0.7,<=0.7.3", @@ -5779,7 +5961,7 @@ "simplesamlphp/simplesamlphp-module-openid": "<1", "simplesamlphp/simplesamlphp-module-openidprovider": "<0.9", "simplesamlphp/xml-common": "<1.20", - "simplesamlphp/xml-security": "==1.6.11", + "simplesamlphp/xml-security": "<1.13.9|>=2,<2.3.1", "simplito/elliptic-php": "<1.0.6", "sitegeist/fluid-components": "<3.5", "sjbr/sr-feuser-register": "<2.6.2|>=5.1,<12.5", @@ -5789,10 +5971,10 @@ "slim/slim": "<2.6", "slub/slub-events": "<3.0.3", "smarty/smarty": "<4.5.3|>=5,<5.1.1", - "snipe/snipe-it": "<=8.3.4", + "snipe/snipe-it": "<8.3.7", "socalnick/scn-social-auth": "<1.15.2", "socialiteproviders/steam": "<1.1", - "solspace/craft-freeform": ">=5,<5.10.16", + "solspace/craft-freeform": "<4.1.29|>=5,<=5.14.6", "soosyze/soosyze": "<=2", "spatie/browsershot": "<5.0.5", "spatie/image-optimizer": "<1.7.3", @@ -5807,14 +5989,14 @@ "starcitizentools/short-description": ">=4,<4.0.1", "starcitizentools/tabber-neue": ">=1.9.1,<2.7.2|>=3,<3.1.1", "starcitizenwiki/embedvideo": "<=4", - "statamic/cms": "<=5.22", + "statamic/cms": "<5.73.20|>=6,<6.13", "stormpath/sdk": "<9.9.99", - "studio-42/elfinder": "<=2.1.64", + "studio-42/elfinder": "<2.1.67", "studiomitte/friendlycaptcha": "<0.1.4", "subhh/libconnect": "<7.0.8|>=8,<8.1", "sukohi/surpass": "<1", "sulu/form-bundle": ">=2,<2.5.3", - "sulu/sulu": "<1.6.44|>=2,<2.5.25|>=2.6,<2.6.9|>=3.0.0.0-alpha1,<3.0.0.0-alpha3", + "sulu/sulu": "<2.6.22|>=3,<3.0.5", "sumocoders/framework-user-bundle": "<1.4", "superbig/craft-audit": "<3.0.2", "svewap/a21glossary": "<=0.4.10", @@ -5826,7 +6008,7 @@ "sylius/grid-bundle": "<1.10.1", "sylius/paypal-plugin": "<1.6.2|>=1.7,<1.7.2|>=2,<2.0.2", "sylius/resource-bundle": ">=1,<1.3.14|>=1.4,<1.4.7|>=1.5,<1.5.2|>=1.6,<1.6.4", - "sylius/sylius": "<1.12.19|>=1.13.0.0-alpha1,<1.13.4", + "sylius/sylius": "<1.9.12|>=1.10,<1.10.16|>=1.11,<1.11.17|>=1.12,<=1.12.22|>=1.13,<=1.13.14|>=1.14,<=1.14.17|>=2,<=2.0.15|>=2.1,<=2.1.11|>=2.2,<=2.2.2", "symbiote/silverstripe-multivaluefield": ">=3,<3.1", "symbiote/silverstripe-queuedjobs": ">=3,<3.0.2|>=3.1,<3.1.4|>=4,<4.0.7|>=4.1,<4.1.2|>=4.2,<4.2.4|>=4.3,<4.3.3|>=4.4,<4.4.3|>=4.5,<4.5.1|>=4.6,<4.6.4", "symbiote/silverstripe-seed": "<6.0.3", @@ -5846,7 +6028,7 @@ "symfony/phpunit-bridge": ">=2.8,<2.8.50|>=3,<3.4.26|>=4,<4.1.12|>=4.2,<4.2.7", "symfony/polyfill": ">=1,<1.10", "symfony/polyfill-php55": ">=1,<1.10", - "symfony/process": "<5.4.46|>=6,<6.4.14|>=7,<7.1.7", + "symfony/process": "<5.4.51|>=6,<6.4.33|>=7,<7.1.7|>=7.3,<7.3.11|>=7.4,<7.4.5|>=8,<8.0.5", "symfony/proxy-manager-bridge": ">=2.7,<2.7.51|>=2.8,<2.8.50|>=3,<3.4.26|>=4,<4.1.12|>=4.2,<4.2.7", "symfony/routing": ">=2,<2.0.19", "symfony/runtime": ">=5.3,<5.4.46|>=6,<6.4.14|>=7,<7.1.7", @@ -5857,7 +6039,7 @@ "symfony/security-guard": ">=2.8,<3.4.48|>=4,<4.4.23|>=5,<5.2.8", "symfony/security-http": ">=2.3,<2.3.41|>=2.4,<2.7.51|>=2.8,<2.8.50|>=3,<3.4.26|>=4,<4.2.12|>=4.3,<4.3.8|>=4.4,<4.4.7|>=5,<5.0.7|>=5.1,<5.2.8|>=5.3,<5.4.47|>=6,<6.4.15|>=7,<7.1.8", "symfony/serializer": ">=2,<2.0.11|>=4.1,<4.4.35|>=5,<5.3.12", - "symfony/symfony": "<5.4.50|>=6,<6.4.29|>=7,<7.3.7", + "symfony/symfony": "<5.4.51|>=6,<6.4.33|>=7,<7.3.11|>=7.4,<7.4.5|>=8,<8.0.5", "symfony/translation": ">=2,<2.0.17", "symfony/twig-bridge": ">=2,<4.4.51|>=5,<5.4.31|>=6,<6.3.8", "symfony/ux-autocomplete": "<2.11.2", @@ -5881,7 +6063,7 @@ "thelia/thelia": ">=2.1,<2.1.3", "theonedemon/phpwhois": "<=4.2.5", "thinkcmf/thinkcmf": "<6.0.8", - "thorsten/phpmyfaq": "<=4.0.13", + "thorsten/phpmyfaq": "<4.1.1", "tikiwiki/tiki-manager": "<=17.1", "timber/timber": ">=0.16.6,<1.23.1|>=1.24,<1.24.1|>=2,<2.1", "tinymce/tinymce": "<7.2", @@ -5899,11 +6081,12 @@ "ttskch/pagination-service-provider": "<1", "twbs/bootstrap": "<3.4.1|>=4,<4.3.1", "twig/twig": "<3.11.2|>=3.12,<3.14.1|>=3.16,<3.19", + "typicms/core": "<16.1.7", "typo3/cms": "<9.5.29|>=10,<10.4.35|>=11,<11.5.23|>=12,<12.2", - "typo3/cms-backend": "<4.1.14|>=4.2,<4.2.15|>=4.3,<4.3.7|>=4.4,<4.4.4|>=7,<=7.6.50|>=8,<=8.7.39|>=9,<9.5.55|>=10,<10.4.54|>=11,<11.5.48|>=12,<12.4.37|>=13,<13.4.18", + "typo3/cms-backend": "<4.1.14|>=4.2,<4.2.15|>=4.3,<4.3.7|>=4.4,<4.4.4|>=7,<=7.6.50|>=8,<=8.7.39|>=9,<9.5.55|>=10,<=10.4.54|>=11,<=11.5.48|>=12,<=12.4.40|>=13,<=13.4.22|>=14,<=14.0.1|==14.2", "typo3/cms-belog": ">=10,<=10.4.47|>=11,<=11.5.41|>=12,<=12.4.24|>=13,<=13.4.2", "typo3/cms-beuser": ">=9,<9.5.55|>=10,<10.4.54|>=11,<11.5.48|>=12,<12.4.37|>=13,<13.4.18", - "typo3/cms-core": "<=8.7.56|>=9,<9.5.55|>=10,<10.4.54|>=11,<11.5.48|>=12,<12.4.37|>=13,<13.4.18", + "typo3/cms-core": "<=8.7.56|>=9,<9.5.55|>=10,<=10.4.54|>=11,<=11.5.48|>=12,<=12.4.40|>=13,<=13.4.22|>=14,<=14.0.1", "typo3/cms-dashboard": ">=10,<10.4.54|>=11,<11.5.48|>=12,<12.4.37|>=13,<13.4.18", "typo3/cms-extbase": "<6.2.24|>=7,<7.6.8|==8.1.1", "typo3/cms-extensionmanager": ">=10,<=10.4.47|>=11,<=11.5.41|>=12,<=12.4.24|>=13,<=13.4.2", @@ -5915,7 +6098,8 @@ "typo3/cms-install": "<4.1.14|>=4.2,<4.2.16|>=4.3,<4.3.9|>=4.4,<4.4.5|>=12.2,<12.4.8|==13.4.2", "typo3/cms-lowlevel": ">=11,<=11.5.41", "typo3/cms-recordlist": ">=11,<11.5.48", - "typo3/cms-recycler": ">=9,<9.5.55|>=10,<10.4.54|>=11,<11.5.48|>=12,<12.4.37|>=13,<13.4.18", + "typo3/cms-recycler": ">=9,<9.5.55|>=10,<=10.4.54|>=11,<=11.5.48|>=12,<=12.4.40|>=13,<=13.4.22|>=14,<=14.0.1", + "typo3/cms-redirects": ">=10,<=10.4.54|>=11,<=11.5.48|>=12,<=12.4.40|>=13,<=13.4.22|>=14,<=14.0.1", "typo3/cms-rte-ckeditor": ">=9.5,<9.5.42|>=10,<10.4.39|>=11,<11.5.30", "typo3/cms-scheduler": ">=11,<=11.5.41", "typo3/cms-setup": ">=9,<=9.5.50|>=10,<=10.4.49|>=11,<=11.5.43|>=12,<=12.4.30|>=13,<=13.4.11", @@ -5945,28 +6129,30 @@ "vertexvaar/falsftp": "<0.2.6", "villagedefrance/opencart-overclocked": "<=1.11.1", "vova07/yii2-fileapi-widget": "<0.1.9", - "vrana/adminer": "<=4.8.1", + "vrana/adminer": "<5.4.2", "vufind/vufind": ">=2,<9.1.1", "waldhacker/hcaptcha": "<2.1.2", "wallabag/tcpdf": "<6.2.22", "wallabag/wallabag": "<2.6.11", "wanglelecc/laracms": "<=1.0.3", "wapplersystems/a21glossary": "<=0.4.10", - "web-auth/webauthn-framework": ">=3.3,<3.3.4|>=4.5,<4.9", - "web-auth/webauthn-lib": ">=4.5,<4.9", + "web-auth/webauthn-framework": ">=3.3,<3.3.4|>=4.5,<4.9|>=5.2,<5.2.4", + "web-auth/webauthn-lib": ">=4.5,<4.9|>=5.2,<5.2.4", + "web-auth/webauthn-symfony-bundle": ">=5.2,<5.2.4", "web-feet/coastercms": "==5.5", "web-tp3/wec_map": "<3.0.3", "webbuilders-group/silverstripe-kapost-bridge": "<0.4", "webcoast/deferred-image-processing": "<1.0.2", "webklex/laravel-imap": "<5.3", "webklex/php-imap": "<5.3", + "webonyx/graphql-php": "<=15.31.4", "webpa/webpa": "<3.1.2", "webreinvent/vaahcms": "<=2.3.1", "wikibase/wikibase": "<=1.39.3", "wikimedia/parsoid": "<0.12.2", "willdurand/js-translation-bundle": "<2.1.1", - "winter/wn-backend-module": "<1.2.4", - "winter/wn-cms-module": "<1.0.476|>=1.1,<1.1.11|>=1.2,<1.2.7", + "winter/wn-backend-module": "<1.2.12", + "winter/wn-cms-module": "<=1.2.9", "winter/wn-dusk-plugin": "<2.1", "winter/wn-system-module": "<1.2.4", "wintercms/winter": "<=1.2.3", @@ -5978,11 +6164,13 @@ "wpanel/wpanel4-cms": "<=4.3.1", "wpcloud/wp-stateless": "<3.2", "wpglobus/wpglobus": "<=1.9.6", - "wwbn/avideo": "<14.3", + "wpmetabox/meta-box": "<5.11.2", + "wwbn/avideo": "<=29", "xataface/xataface": "<3", "xpressengine/xpressengine": "<3.0.15", "yab/quarx": "<2.4.5", - "yeswiki/yeswiki": "<=4.5.4", + "yansongda/pay": "<=3.7.19", + "yeswiki/yeswiki": "<=4.6", "yetiforce/yetiforce-crm": "<6.5", "yidashi/yii2cmf": "<=2", "yii2mod/yii2-cms": "<1.9.2", @@ -5997,7 +6185,8 @@ "yiisoft/yii2-redis": "<2.0.20", "yikesinc/yikes-inc-easy-mailchimp-extender": "<6.8.6", "yoast-seo-for-typo3/yoast_seo": "<7.2.3", - "yourls/yourls": "<=1.8.2", + "yoast/duplicate-post": "<=4.5", + "yourls/yourls": "<=1.10.2", "yuan1994/tpadmin": "<=1.3.12", "yungifez/skuul": "<=2.6.5", "z-push/z-push-dev": "<2.7.6", @@ -6037,7 +6226,8 @@ "zf-commons/zfc-user": "<1.2.2", "zfcampus/zf-apigility-doctrine": ">=1,<1.0.3", "zfr/zfr-oauth2-server-module": "<0.1.2", - "zoujingli/thinkadmin": "<=6.1.53" + "zoujingli/thinkadmin": "<=6.1.53", + "zumba/json-serializer": "<3.2.3" }, "default-branch": true, "type": "metapackage", @@ -6075,33 +6265,33 @@ "type": "tidelift" } ], - "time": "2025-12-16T01:34:46+00:00" + "time": "2026-04-30T21:24:12+00:00" }, { "name": "sebastian/diff", - "version": "7.0.0", + "version": "8.1.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/diff.git", - "reference": "7ab1ea946c012266ca32390913653d844ecd085f" + "reference": "9c957d730257f49c873f3761674559bd90098a7d" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7ab1ea946c012266ca32390913653d844ecd085f", - "reference": "7ab1ea946c012266ca32390913653d844ecd085f", + "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/9c957d730257f49c873f3761674559bd90098a7d", + "reference": "9c957d730257f49c873f3761674559bd90098a7d", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0", + "phpunit/phpunit": "^13.0", "symfony/process": "^7.2" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.1-dev" } }, "autoload": { @@ -6134,28 +6324,40 @@ "support": { "issues": "https://github.com/sebastianbergmann/diff/issues", "security": "https://github.com/sebastianbergmann/diff/security/policy", - "source": "https://github.com/sebastianbergmann/diff/tree/7.0.0" + "source": "https://github.com/sebastianbergmann/diff/tree/8.1.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/diff", + "type": "tidelift" } ], - "time": "2025-02-07T04:55:46+00:00" + "time": "2026-04-05T12:02:33+00:00" }, { "name": "symfony/console", - "version": "v8.0.1", + "version": "v8.0.9", "source": { "type": "git", "url": "https://github.com/symfony/console.git", - "reference": "fcb73f69d655b48fcb894a262f074218df08bd58" + "reference": "7113778e2e91f4709cb3194a75dfa9c0d028d94d" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/console/zipball/fcb73f69d655b48fcb894a262f074218df08bd58", - "reference": "fcb73f69d655b48fcb894a262f074218df08bd58", + "url": "https://api.github.com/repos/symfony/console/zipball/7113778e2e91f4709cb3194a75dfa9c0d028d94d", + "reference": "7113778e2e91f4709cb3194a75dfa9c0d028d94d", "shasum": "" }, "require": { @@ -6212,7 +6414,7 @@ "terminal" ], "support": { - "source": "https://github.com/symfony/console/tree/v8.0.1" + "source": "https://github.com/symfony/console/tree/v8.0.9" }, "funding": [ { @@ -6232,20 +6434,20 @@ "type": "tidelift" } ], - "time": "2025-12-05T15:25:33+00:00" + "time": "2026-04-29T15:02:55+00:00" }, { "name": "symfony/event-dispatcher", - "version": "v8.0.0", + "version": "v8.0.9", "source": { "type": "git", "url": "https://github.com/symfony/event-dispatcher.git", - "reference": "573f95783a2ec6e38752979db139f09fec033f03" + "reference": "0c3c1a17604c4dbbec4b93fe162c538482096e1f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/573f95783a2ec6e38752979db139f09fec033f03", - "reference": "573f95783a2ec6e38752979db139f09fec033f03", + "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/0c3c1a17604c4dbbec4b93fe162c538482096e1f", + "reference": "0c3c1a17604c4dbbec4b93fe162c538482096e1f", "shasum": "" }, "require": { @@ -6297,7 +6499,7 @@ "description": "Provides tools that allow your application components to communicate with each other by dispatching events and listening to them", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/event-dispatcher/tree/v8.0.0" + "source": "https://github.com/symfony/event-dispatcher/tree/v8.0.9" }, "funding": [ { @@ -6317,7 +6519,7 @@ "type": "tidelift" } ], - "time": "2025-10-30T14:17:19+00:00" + "time": "2026-04-18T13:51:42+00:00" }, { "name": "symfony/event-dispatcher-contracts", @@ -6397,16 +6599,16 @@ }, { "name": "symfony/filesystem", - "version": "v8.0.1", + "version": "v8.0.9", "source": { "type": "git", "url": "https://github.com/symfony/filesystem.git", - "reference": "d937d400b980523dc9ee946bb69972b5e619058d" + "reference": "d1ec4543d5c6c2dac78503c2fae5ea0b3608ce40" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/filesystem/zipball/d937d400b980523dc9ee946bb69972b5e619058d", - "reference": "d937d400b980523dc9ee946bb69972b5e619058d", + "url": "https://api.github.com/repos/symfony/filesystem/zipball/d1ec4543d5c6c2dac78503c2fae5ea0b3608ce40", + "reference": "d1ec4543d5c6c2dac78503c2fae5ea0b3608ce40", "shasum": "" }, "require": { @@ -6443,7 +6645,7 @@ "description": "Provides basic utilities for the filesystem", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/filesystem/tree/v8.0.1" + "source": "https://github.com/symfony/filesystem/tree/v8.0.9" }, "funding": [ { @@ -6463,20 +6665,20 @@ "type": "tidelift" } ], - "time": "2025-12-01T09:13:36+00:00" + "time": "2026-04-18T13:51:42+00:00" }, { "name": "symfony/finder", - "version": "v8.0.0", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/finder.git", - "reference": "7598dd5770580fa3517ec83e8da0c9b9e01f4291" + "reference": "8da41214757b87d97f181e3d14a4179286151007" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/finder/zipball/7598dd5770580fa3517ec83e8da0c9b9e01f4291", - "reference": "7598dd5770580fa3517ec83e8da0c9b9e01f4291", + "url": "https://api.github.com/repos/symfony/finder/zipball/8da41214757b87d97f181e3d14a4179286151007", + "reference": "8da41214757b87d97f181e3d14a4179286151007", "shasum": "" }, "require": { @@ -6511,7 +6713,7 @@ "description": "Finds files and directories via an intuitive fluent interface", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/finder/tree/v8.0.0" + "source": "https://github.com/symfony/finder/tree/v8.0.8" }, "funding": [ { @@ -6531,20 +6733,20 @@ "type": "tidelift" } ], - "time": "2025-11-05T14:36:47+00:00" + "time": "2026-03-30T15:14:47+00:00" }, { "name": "symfony/options-resolver", - "version": "v8.0.0", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/options-resolver.git", - "reference": "d2b592535ffa6600c265a3893a7f7fd2bad82dd7" + "reference": "b48bce0a70b914f6953dafbd10474df232ed4de8" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/options-resolver/zipball/d2b592535ffa6600c265a3893a7f7fd2bad82dd7", - "reference": "d2b592535ffa6600c265a3893a7f7fd2bad82dd7", + "url": "https://api.github.com/repos/symfony/options-resolver/zipball/b48bce0a70b914f6953dafbd10474df232ed4de8", + "reference": "b48bce0a70b914f6953dafbd10474df232ed4de8", "shasum": "" }, "require": { @@ -6582,7 +6784,7 @@ "options" ], "support": { - "source": "https://github.com/symfony/options-resolver/tree/v8.0.0" + "source": "https://github.com/symfony/options-resolver/tree/v8.0.8" }, "funding": [ { @@ -6602,20 +6804,20 @@ "type": "tidelift" } ], - "time": "2025-11-12T15:55:31+00:00" + "time": "2026-03-30T15:14:47+00:00" }, { "name": "symfony/polyfill-intl-grapheme", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-intl-grapheme.git", - "reference": "380872130d3a5dd3ace2f4010d95125fde5d5c70" + "reference": "4864388bfbd3001ce88e234fab652acd91fdc57e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-grapheme/zipball/380872130d3a5dd3ace2f4010d95125fde5d5c70", - "reference": "380872130d3a5dd3ace2f4010d95125fde5d5c70", + "url": "https://api.github.com/repos/symfony/polyfill-intl-grapheme/zipball/4864388bfbd3001ce88e234fab652acd91fdc57e", + "reference": "4864388bfbd3001ce88e234fab652acd91fdc57e", "shasum": "" }, "require": { @@ -6664,7 +6866,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-intl-grapheme/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-intl-grapheme/tree/v1.37.0" }, "funding": [ { @@ -6684,11 +6886,11 @@ "type": "tidelift" } ], - "time": "2025-06-27T09:58:17+00:00" + "time": "2026-04-26T13:13:48+00:00" }, { "name": "symfony/polyfill-intl-normalizer", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-intl-normalizer.git", @@ -6749,7 +6951,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.37.0" }, "funding": [ { @@ -6773,7 +6975,7 @@ }, { "name": "symfony/polyfill-php81", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php81.git", @@ -6829,7 +7031,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-php81/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-php81/tree/v1.37.0" }, "funding": [ { @@ -6853,16 +7055,16 @@ }, { "name": "symfony/process", - "version": "v8.0.0", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/process.git", - "reference": "a0a750500c4ce900d69ba4e9faf16f82c10ee149" + "reference": "cb8939aff03470d1a9d1d1b66d08c6fa71b3bbdc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/process/zipball/a0a750500c4ce900d69ba4e9faf16f82c10ee149", - "reference": "a0a750500c4ce900d69ba4e9faf16f82c10ee149", + "url": "https://api.github.com/repos/symfony/process/zipball/cb8939aff03470d1a9d1d1b66d08c6fa71b3bbdc", + "reference": "cb8939aff03470d1a9d1d1b66d08c6fa71b3bbdc", "shasum": "" }, "require": { @@ -6894,7 +7096,7 @@ "description": "Executes commands in sub-processes", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/process/tree/v8.0.0" + "source": "https://github.com/symfony/process/tree/v8.0.8" }, "funding": [ { @@ -6914,7 +7116,7 @@ "type": "tidelift" } ], - "time": "2025-10-16T16:25:44+00:00" + "time": "2026-03-30T15:14:47+00:00" }, { "name": "symfony/service-contracts", @@ -7005,16 +7207,16 @@ }, { "name": "symfony/stopwatch", - "version": "v8.0.0", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/stopwatch.git", - "reference": "67df1914c6ccd2d7b52f70d40cf2aea02159d942" + "reference": "85954ed72d5440ea4dc9a10b7e49e01df766ffa3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/stopwatch/zipball/67df1914c6ccd2d7b52f70d40cf2aea02159d942", - "reference": "67df1914c6ccd2d7b52f70d40cf2aea02159d942", + "url": "https://api.github.com/repos/symfony/stopwatch/zipball/85954ed72d5440ea4dc9a10b7e49e01df766ffa3", + "reference": "85954ed72d5440ea4dc9a10b7e49e01df766ffa3", "shasum": "" }, "require": { @@ -7047,7 +7249,7 @@ "description": "Provides a way to profile code", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/stopwatch/tree/v8.0.0" + "source": "https://github.com/symfony/stopwatch/tree/v8.0.8" }, "funding": [ { @@ -7067,20 +7269,20 @@ "type": "tidelift" } ], - "time": "2025-08-04T07:36:47+00:00" + "time": "2026-03-30T15:14:47+00:00" }, { "name": "symfony/string", - "version": "v8.0.1", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/string.git", - "reference": "ba65a969ac918ce0cc3edfac6cdde847eba231dc" + "reference": "ae9488f874d7603f9d2dfbf120203882b645d963" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/string/zipball/ba65a969ac918ce0cc3edfac6cdde847eba231dc", - "reference": "ba65a969ac918ce0cc3edfac6cdde847eba231dc", + "url": "https://api.github.com/repos/symfony/string/zipball/ae9488f874d7603f9d2dfbf120203882b645d963", + "reference": "ae9488f874d7603f9d2dfbf120203882b645d963", "shasum": "" }, "require": { @@ -7137,7 +7339,7 @@ "utf8" ], "support": { - "source": "https://github.com/symfony/string/tree/v8.0.1" + "source": "https://github.com/symfony/string/tree/v8.0.8" }, "funding": [ { @@ -7157,7 +7359,7 @@ "type": "tidelift" } ], - "time": "2025-12-01T09:13:36+00:00" + "time": "2026-03-30T15:14:47+00:00" }, { "name": "szepeviktor/phpstan-wordpress", @@ -7225,37 +7427,37 @@ }, { "name": "vincentlanglet/twig-cs-fixer", - "version": "3.11.0", + "version": "3.14.0", "source": { "type": "git", "url": "https://github.com/VincentLanglet/Twig-CS-Fixer.git", - "reference": "866af065fd09980b6390ee5c69e45b08053101e8" + "reference": "599f110f192c31af5deb5736d6c1a970afdf51f3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/VincentLanglet/Twig-CS-Fixer/zipball/866af065fd09980b6390ee5c69e45b08053101e8", - "reference": "866af065fd09980b6390ee5c69e45b08053101e8", + "url": "https://api.github.com/repos/VincentLanglet/Twig-CS-Fixer/zipball/599f110f192c31af5deb5736d6c1a970afdf51f3", + "reference": "599f110f192c31af5deb5736d6c1a970afdf51f3", "shasum": "" }, "require": { "composer-runtime-api": "^2.0.0", "ext-ctype": "*", - "ext-json": "*", - "php": ">=8.0", + "php": ">=8.1", "symfony/console": "^5.4.9 || ^6.4 || ^7.0 || ^8.0", "symfony/filesystem": "^5.4 || ^6.4 || ^7.0 || ^8.0", "symfony/finder": "^5.4 || ^6.4 || ^7.0 || ^8.0", "symfony/string": "^5.4.42 || ^6.4.10 || ~7.0.10 || ^7.1.3 || ^8.0", "twig/twig": "^3.4", - "webmozart/assert": "^1.10" + "webmozart/assert": "^1.10 || ^2.0" }, "require-dev": { "composer/semver": "^3.2.0", "dereuromark/composer-prefer-lowest": "^0.1.10", "ergebnis/composer-normalize": "^2.29", "friendsofphp/php-cs-fixer": "^3.13.0", - "infection/infection": "^0.26.16 || ^0.29.14", + "infection/infection": "^0.26.16 || ^0.32.0", "phpstan/phpstan": "^2.0", + "phpstan/phpstan-deprecation-rules": "^2.0", "phpstan/phpstan-phpunit": "^2.0", "phpstan/phpstan-strict-rules": "^2.0", "phpstan/phpstan-symfony": "^2.0", @@ -7290,7 +7492,7 @@ "homepage": "https://github.com/VincentLanglet/Twig-CS-Fixer", "support": { "issues": "https://github.com/VincentLanglet/Twig-CS-Fixer/issues", - "source": "https://github.com/VincentLanglet/Twig-CS-Fixer/tree/3.11.0" + "source": "https://github.com/VincentLanglet/Twig-CS-Fixer/tree/3.14.0" }, "funding": [ { @@ -7298,27 +7500,27 @@ "type": "github" } ], - "time": "2025-11-24T18:13:18+00:00" + "time": "2026-02-23T13:21:35+00:00" }, { "name": "webmozart/assert", - "version": "1.12.1", + "version": "2.3.0", "source": { "type": "git", "url": "https://github.com/webmozarts/assert.git", - "reference": "9be6926d8b485f55b9229203f962b51ed377ba68" + "reference": "eb0d790f735ba6cff25c683a85a1da0eadeff9e4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/webmozarts/assert/zipball/9be6926d8b485f55b9229203f962b51ed377ba68", - "reference": "9be6926d8b485f55b9229203f962b51ed377ba68", + "url": "https://api.github.com/repos/webmozarts/assert/zipball/eb0d790f735ba6cff25c683a85a1da0eadeff9e4", + "reference": "eb0d790f735ba6cff25c683a85a1da0eadeff9e4", "shasum": "" }, "require": { "ext-ctype": "*", "ext-date": "*", "ext-filter": "*", - "php": "^7.2 || ^8.0" + "php": "^8.2" }, "suggest": { "ext-intl": "", @@ -7328,7 +7530,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.10-dev" + "dev-feature/2-0": "2.0-dev" } }, "autoload": { @@ -7344,6 +7546,10 @@ { "name": "Bernhard Schussek", "email": "bschussek@gmail.com" + }, + { + "name": "Woody Gilk", + "email": "woody.gilk@gmail.com" } ], "description": "Assertions to validate method input/output with nice error messages.", @@ -7354,13 +7560,13 @@ ], "support": { "issues": "https://github.com/webmozarts/assert/issues", - "source": "https://github.com/webmozarts/assert/tree/1.12.1" + "source": "https://github.com/webmozarts/assert/tree/2.3.0" }, - "time": "2025-10-29T15:56:20+00:00" + "time": "2026-04-11T10:33:05+00:00" } ], "aliases": [], - "minimum-stability": "dev", + "minimum-stability": "stable", "stability-flags": { "roave/security-advisories": 20, "szepeviktor/phpstan-wordpress": 20 @@ -7371,5 +7577,5 @@ "php": ">=8.5" }, "platform-dev": {}, - "plugin-api-version": "2.6.0" + "plugin-api-version": "2.9.0" } diff --git a/config/application.php b/config/application.php index c2e09f0a..bc828422 100755 --- a/config/application.php +++ b/config/application.php @@ -11,10 +11,10 @@ declare(strict_types=1); -use function Env\env; - use Roots\WPConfig\Config; +use function Env\env; + // USE_ENV_ARRAY + CONVERT_* + STRIP_QUOTES Env\Env::$options = 31; @@ -30,26 +30,23 @@ $root_dir = dirname(__DIR__); * * @var string */ -$webroot_dir = $root_dir.'/web'; +$webroot_dir = $root_dir . '/web'; /* * Use Dotenv to set required environment variables and load .env file in root * .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']; +if (file_exists($root_dir . '/.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']); + } } /* @@ -60,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 @@ -69,12 +66,12 @@ Config::define('WP_SITEURL', env('WP_SITEURL')); // Custom Content Directory Config::define('CONTENT_DIR', '/app'); -Config::define('WP_CONTENT_DIR', $webroot_dir.Config::get('CONTENT_DIR')); -Config::define('WP_CONTENT_URL', Config::get('WP_HOME').Config::get('CONTENT_DIR')); +Config::define('WP_CONTENT_DIR', $webroot_dir . Config::get('CONTENT_DIR')); +Config::define('WP_CONTENT_URL', Config::get('WP_HOME') . Config::get('CONTENT_DIR')); // 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')); @@ -86,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 @@ -124,26 +121,26 @@ Config::define('SCRIPT_DEBUG', false); ini_set('display_errors', '0'); // Plugins -Config::define('WPMU_PLUGIN_DIR', Config::get('WP_CONTENT_DIR').'/mu-plugins'); -Config::define('WP_PLUGIN_DIR', Config::get('WP_CONTENT_DIR').'/plugins'); +Config::define('WPMU_PLUGIN_DIR', Config::get('WP_CONTENT_DIR') . '/mu-plugins'); +Config::define('WP_PLUGIN_DIR', Config::get('WP_CONTENT_DIR') . '/plugins'); /* * Allow WordPress to detect HTTPS when used behind a reverse proxy or a load balancer * 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'; +$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/config/environments/development.php b/config/environments/development.php index c6a272ad..df784947 100755 --- a/config/environments/development.php +++ b/config/environments/development.php @@ -6,10 +6,11 @@ declare(strict_types=1); -use function Env\env; - use Roots\WPConfig\Config; +use function base64_encode; +use function Env\env; + Config::define('SAVEQUERIES', true); Config::define('WP_DEBUG', true); Config::define('WP_DEBUG_DISPLAY', true); @@ -25,6 +26,10 @@ Config::define('DISALLOW_FILE_MODS', false); // WooCommerce Config::define('WOOCOMMERCE_API_CONSUMER_KEY', env('WOOCOMMERCE_API_CONSUMER_KEY')); Config::define('WOOCOMMERCE_API_CONSUMER_SECRET', env('WOOCOMMERCE_API_CONSUMER_SECRET')); +Config::define( + 'WOOCOMMERCE_API_AUTH_STRING', + base64_encode(env('WOOCOMMERCE_API_CONSUMER_KEY') . ':' . env('WOOCOMMERCE_API_CONSUMER_SECRET')), +); // Stripe Config::define('STRIPE_API_SECRET', env('STRIPE_API_SECRET')); diff --git a/config/environments/production.php b/config/environments/production.php index 249fe661..0047176f 100755 --- a/config/environments/production.php +++ b/config/environments/production.php @@ -6,10 +6,11 @@ declare(strict_types=1); -use function Env\env; - use Roots\WPConfig\Config; +use function base64_encode; +use function Env\env; + Config::define('WP_DEBUG', true); Config::define('WP_DEBUG_DISPLAY', false); Config::define('WP_DEBUG_LOG', env('WP_DEBUG_LOG') ?? true); @@ -20,6 +21,10 @@ Config::define('DISALLOW_FILE_MODS', false); Config::define('WOOCOMMERCE_API_CONSUMER_KEY', env('WOOCOMMERCE_API_CONSUMER_KEY')); Config::define('WOOCOMMERCE_API_CONSUMER_SECRET', env('WOOCOMMERCE_API_CONSUMER_SECRET')); +Config::define( + 'WOOCOMMERCE_API_AUTH_STRING', + base64_encode(env('WOOCOMMERCE_API_CONSUMER_KEY') . ':' . env('WOOCOMMERCE_API_CONSUMER_SECRET')), +); // Stripe Config::define('STRIPE_API_SECRET', env('STRIPE_API_SECRET')); diff --git a/config/environments/staging.php b/config/environments/staging.php index 3ae418be..0f7ba42b 100755 --- a/config/environments/staging.php +++ b/config/environments/staging.php @@ -6,10 +6,15 @@ declare(strict_types=1); -use function Env\env; - use Roots\WPConfig\Config; +use function base64_encode; +use function Env\env; + Config::define('DISALLOW_INDEXING', true); Config::define('WOOCOMMERCE_API_CONSUMER_KEY', env('WOOCOMMERCE_API_CONSUMER_KEY')); Config::define('WOOCOMMERCE_API_CONSUMER_SECRET', env('WOOCOMMERCE_API_CONSUMER_SECRET')); +Config::define( + 'WOOCOMMERCE_API_AUTH_STRING', + base64_encode(env('WOOCOMMERCE_API_CONSUMER_KEY') . ':' . env('WOOCOMMERCE_API_CONSUMER_SECRET')), +); diff --git a/containers/Dockerfile b/containers/Dockerfile index 9ce1b86a..0272e7c7 100644 --- a/containers/Dockerfile +++ b/containers/Dockerfile @@ -14,10 +14,10 @@ FROM docker.io/library/wordpress:php8.5-fpm-alpine AS php ENTRYPOINT [] LABEL org.opencontainers.image.title=wordpress-haiku-atelier \ - org.opencontainers.image.description="WordPress pour Haiku Atelier" \ - org.opencontainers.image.authors="gcch" \ - org.opencontainers.image.vendor="gcch" \ - org.opencontainers.image.licenses=AGPL-3.0 + org.opencontainers.image.description="WordPress pour Haiku Atelier" \ + org.opencontainers.image.authors="gcch" \ + org.opencontainers.image.vendor="gcch" \ + org.opencontainers.image.licenses=AGPL-3.0 # Installe wp-cli. RUN curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar && chmod +x wp-cli.phar && mv wp-cli.phar /usr/local/bin/wp @@ -36,7 +36,8 @@ VOLUME /var/www/wordpress WORKDIR /var/www/wordpress # Récupère les fichiers du projet. -COPY --from=repo --chmod=777 "/tmp/repo/" . +COPY --from=repo --chmod=775 "/tmp/repo/" . +RUN chown www-data: -R . # Installe les dépendences Composer. RUN composer install diff --git a/containers/conf/angie/angie.conf b/containers/conf/angie/angie.conf index 405d5ae5..7810705c 100755 --- a/containers/conf/angie/angie.conf +++ b/containers/conf/angie/angie.conf @@ -7,6 +7,7 @@ include /etc/angie/modules-enabled/*.conf; pcre_jit on; pid /run/angie.pid; error_log /dev/stdout info; +error_log /var/log/angie/angie.log warn; events { worker_connections 2048; diff --git a/containers/conf/angie/angie.conf-original b/containers/conf/angie/angie.conf-original index 6627092f..1f0edd51 100644 --- a/containers/conf/angie/angie.conf-original +++ b/containers/conf/angie/angie.conf-original @@ -1,117 +1,85 @@ - -#user nobody; -worker_processes 1; - -#error_log logs/error.log; -#error_log logs/error.log notice; -#error_log logs/error.log info; - -#pid logs/angie.pid; - +user www-data; +worker_processes auto; +pid /run/angie.pid; +include /etc/angie/modules-enabled/*.conf; events { - worker_connections 1024; + worker_connections 768; + # multi_accept on; } - http { - include mime.types; - default_type application/octet-stream; - #log_format main '$remote_addr - $remote_user [$time_local] "$request" ' - # '$status $body_bytes_sent "$http_referer" ' - # '"$http_user_agent" "$http_x_forwarded_for"'; + ## + # Basic Settings + ## - #access_log logs/access.log main; + sendfile on; + tcp_nopush on; + tcp_nodelay on; + keepalive_timeout 65; + types_hash_max_size 2048; + # server_tokens off; - sendfile on; - #tcp_nopush on; + # server_names_hash_bucket_size 64; + # server_name_in_redirect off; - #keepalive_timeout 0; - keepalive_timeout 65; + include /etc/angie/mime.types; + default_type application/octet-stream; - #gzip on; + ## + # SSL Settings + ## - server { - listen 80; - server_name localhost; + ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; # Dropping SSLv3, ref: POODLE + ssl_prefer_server_ciphers on; - #charset koi8-r; + ## + # Logging Settings + ## - #access_log logs/host.access.log main; + access_log /var/log/angie/access.log; + error_log /var/log/angie/error.log; - location / { - root html; - index index.html index.htm; - } + ## + # Gzip Settings + ## - #error_page 404 /404.html; + gzip on; - # redirect server error pages to the static page /50x.html - # - error_page 500 502 503 504 /50x.html; - location = /50x.html { - root html; - } + # gzip_vary on; + # gzip_proxied any; + # gzip_comp_level 6; + # gzip_buffers 16 8k; + # gzip_http_version 1.1; + # gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; - # proxy the PHP scripts to Apache listening on 127.0.0.1:80 - # - #location ~ \.php$ { - # proxy_pass http://127.0.0.1; - #} - - # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000 - # - #location ~ \.php$ { - # root html; - # fastcgi_pass 127.0.0.1:9000; - # fastcgi_index index.php; - # fastcgi_param SCRIPT_FILENAME /scripts$fastcgi_script_name; - # include fastcgi_params; - #} - - # deny access to .htaccess files, if Apache's document root - # concurs with Angie's one - # - #location ~ /\.ht { - # deny all; - #} - } - - - # another virtual host using mix of IP-, name-, and port-based configuration - # - #server { - # listen 8000; - # listen somename:8080; - # server_name somename alias another.alias; - - # location / { - # root html; - # index index.html index.htm; - # } - #} - - - # HTTPS server - # - #server { - # listen 443 ssl; - # server_name localhost; - - # ssl_certificate cert.pem; - # ssl_certificate_key cert.key; - - # ssl_session_cache shared:SSL:1m; - # ssl_session_timeout 5m; - - # ssl_ciphers HIGH:!aNULL:!MD5; - # ssl_prefer_server_ciphers on; - - # location / { - # root html; - # index index.html index.htm; - # } - #} + ## + # Virtual Host Configs + ## + include /etc/angie/conf.d/*.conf; + include /etc/angie/sites-enabled/*; } + + +#mail { +# # See sample authentication script at: +# # http://wiki.angie.org/ImapAuthenticateWithApachePhpScript +# +# # auth_http localhost/auth.php; +# # pop3_capabilities "TOP" "USER"; +# # imap_capabilities "IMAP4rev1" "UIDPLUS"; +# +# server { +# listen localhost:110; +# protocol pop3; +# proxy on; +# } +# +# server { +# listen localhost:143; +# protocol imap; +# proxy on; +# } +#} diff --git a/containers/conf/angie/angie.conf-packaged b/containers/conf/angie/angie.conf-packaged index ec0db861..2222e51b 100644 --- a/containers/conf/angie/angie.conf-packaged +++ b/containers/conf/angie/angie.conf-packaged @@ -1,5 +1,5 @@ ### -## This file comes with the "Angie modules" on https://deb.paranoid.nl/angie-modules +## This file comes with the "NGINX Mainline and modules" on https://deb.paranoid.nl/nginx-modules ## It contains various optimizations, examples and tweaks. #### @@ -11,10 +11,8 @@ worker_rlimit_nofile 10000; pid /run/angie.pid; include /etc/angie/modules-enabled/*.conf; -pcre_jit on; - events { - worker_connections 8192; # this can go as high as ulimit -n + worker_connections 65535; multi_accept on; use epoll; } @@ -31,23 +29,20 @@ http { directio 256k; sendfile_max_chunk 256k; - tcp_nopush on; + tcp_nopush off; tcp_nodelay on; + types_hash_max_size 2048; + server_names_hash_bucket_size 128; + variables_hash_max_size 1024; + # server_name_in_redirect off; include /etc/angie/mime.types; - server_name_in_redirect off; # if off, angie will use the requested Host header - source_charset utf-8; # same value as "charset" - + default_type application/octet-stream; ### ## Enable security_headers only if you installed/enabled the module ### # security_headers on; - - - ### - ## Enable other security headers. - ### # hide_server_tokens on; # fastcgi_hide_header X-Powered-By; # server_tokens off; @@ -55,13 +50,15 @@ http { ## # Optimizing TLS over TCP to reduce latency (Cloudflare patch) ## - # ssl_dyn_rec_enable on; + #ssl_dyn_rec_enable on; ## # Enable HTTP2 and HTTP3 # http2 on; #http3 on; + # + ## ## # SSL Settings @@ -81,11 +78,11 @@ http { ssl_early_data on; ssl_session_cache shared:SSL:10m; + ssl_session_cache shared:le_nginx_SSL:10m; #letsencrypt only ssl_session_timeout 1440m; # OCSP Stapling # fetch OCSP records from URL in ssl_certificate and cache them - # Please enter your own nameservers for security ssl_stapling on; ssl_stapling_verify on; resolver 1.1.1.1 8.8.8.8 valid=300; @@ -103,73 +100,51 @@ http { ## # Gzip Settings ## + gzip on; gzip_vary on; gzip_proxied any; gzip_comp_level 6; gzip_buffers 16 8k; gzip_http_version 1.1; - gzip_min_length 250; gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; - ## - # Brotli settings (Please load module first!) - ## - #brotli on; - #brotli_comp_level 4; - #brotli_buffers 32 8k; - #brotli_min_length 1000; - #brotli_static on; - #brotli_types image/svg+xml text/plain text/css application/json application/javascript application/x-javascript text/xml application/xml application/xml+rss text/javascript image/x-icon; - - ## - # ZSTD Settings (Please load module first!) - ## - #zstd on; - #zstd_min_length 256; # no less than 256 bytes - #zstd_comp_level 3; # set the level to # - #zstd_buffers 32 8k; - #zstd_types text/plain text/css application/json application/javascript application/x-javascript text/xml application/xml application/ xml+rss text/javascript image/x-icon; - - ### ## Miscellaneous ### - # cache informations about FDs, frequently accessed files - # can boost performance, but you need to test those values - #open_file_cache max=200000 inactive=20s; - #open_file_cache_valid 30s; - #open_file_cache_min_uses 2; + keepalive_disable none; # allow all browsers to use keepalive connections + keepalive_requests 50; # number of requests per connection, does not affect SPDY + max_ranges 1; # allow a single range header for resumed downloads and to stop large range header DoS attacks + msie_padding off; + #open_file_cache max=10000 inactive=2h; #open_file_cache_errors on; - - server_names_hash_bucket_size 256; - server_names_hash_max_size 2048; - variables_hash_bucket_size 256; - variables_hash_max_size 2048; - map_hash_max_size 2048; - map_hash_bucket_size 256; - - #postpone_output 1440; # postpone sends to match our machine's MSS - read_ahead 512K; # kernel read head set to the output_buffers - output_buffers 4 512k; + #open_file_cache_min_uses 1; + #open_file_cache_valid 1h; + output_buffers 2 512k; + #postpone_output 1440; # postpone sends to match our machine's MSS + read_ahead 512K; # kernel read head set to the output_buffers + server_name_in_redirect off; # if off, angie will use the requested Host header + source_charset utf-8; # same value as "charset" # Buffer size for POST submissions - client_body_buffer_size 80K; + client_body_buffer_size 10K; client_max_body_size 16m; # Buffer size for Headers client_header_buffer_size 1k; + # Allow the server to close the connection after a client stops + # responding. + # Frees up socket-associated memory. + # + reset_timedout_connection on; + # Timeouts, do not keep connections open longer then necessary to reduce # resource usage and deny Slowloris type attacks. - client_body_timeout 12; # maximum time between packets the client can pause when sending angie any data - client_header_timeout 12;# maximum time the client has to send the entire header to ngin - keepalive_timeout 15; # timeout which a single keep-alive client connection will stay open - keepalive_disable none; # allow all browsers to use keepalive connections - keepalive_requests 5000; # number of requests per connection, does not affect SPDY - reset_timedout_connection on; # Allow the server to close the connection after a client stops responding. - send_timeout 12; + client_body_timeout 10s; # maximum time between packets the client can pause when sending angie any data + client_header_timeout 10s; # maximum time the client has to send the entire header to angie + keepalive_timeout 120s; # timeout which a single keep-alive client connection will stay open ## # Virtual Host Configs diff --git a/containers/conf/angie/compression.conf b/containers/conf/angie/compression.conf index cc67c5c4..5432963b 100755 --- a/containers/conf/angie/compression.conf +++ b/containers/conf/angie/compression.conf @@ -7,44 +7,7 @@ gzip_proxied any; gzip_vary on; gzip_disable "msie6"; gzip_static on; -gzip_types - application/atom+xml - application/geo+json - application/javascript - application/json - application/ld+json - application/manifest+json - application/rdf+xml - application/rss+xml - application/vnd.api+json - application/vnd.geo+json - application/vnd.ms-fontobject - application/x-font-opentype - application/x-font-truetype - application/x-font-ttf - application/x-javascript - application/x-web-app-manifest+json - application/xhtml+xml - application/xml - font/eot - font/opentype - font/otf - font/ttf - image/bmpg - image/svg+xml - image/vnd.microsoft.icon - image/x-icon - text/cache-manifest - text/css - text/html - text/javascript - text/plain - text/vcard - text/vnd.rim.location.xloc - text/vtt - text/x-component - text/x-cross-domain-policy - text/xml; +gzip_types application/atom+xml application/geo+json application/javascript application/json application/ld+json application/manifest+json application/rdf+xml application/rss+xml application/vnd.api+json application/vnd.geo+json application/vnd.ms-fontobject application/x-font-opentype application/x-font-truetype application/x-font-ttf application/x-javascript application/x-web-app-manifest+json application/xhtml+xml application/xml font/eot font/opentype font/otf font/ttf image/bmpg image/svg+xml image/vnd.microsoft.icon image/x-icon text/cache-manifest text/css text/html text/javascript text/plain text/vcard text/vnd.rim.location.xloc text/vtt text/x-component text/x-cross-domain-policy text/xml; brotli on; brotli_buffers 32 4K; @@ -62,41 +25,4 @@ zstd_buffers 32 4K; zstd_comp_level 3; zstd_min_length 1000; zstd_static on; -zstd_types - application/atom+xml - application/geo+json - application/javascript - application/json - application/ld+json - application/manifest+json - application/rdf+xml - application/rss+xml - application/vnd.api+json - application/vnd.geo+json - application/vnd.ms-fontobject - application/x-font-opentype - application/x-font-truetype - application/x-font-ttf - application/x-javascript - application/x-web-app-manifest+json - application/xhtml+xml - application/xml - font/eot - font/opentype - font/otf - font/ttf - image/bmpg - image/svg+xml - image/vnd.microsoft.icon - image/x-icon - text/cache-manifest - text/css - text/html - text/javascript - text/plain - text/vcard - text/vnd.rim.location.xloc - text/vtt - text/x-component - text/x-cross-domain-policy - text/xml; \ No newline at end of file +zstd_types application/atom+xml application/geo+json application/javascript application/json application/ld+json application/manifest+json application/rdf+xml application/rss+xml application/vnd.api+json application/vnd.geo+json application/vnd.ms-fontobject application/x-font-opentype application/x-font-truetype application/x-font-ttf application/x-javascript application/x-web-app-manifest+json application/xhtml+xml application/xml font/eot font/opentype font/otf font/ttf image/bmpg image/svg+xml image/vnd.microsoft.icon image/x-icon text/cache-manifest text/css text/html text/javascript text/plain text/vcard text/vnd.rim.location.xloc text/vtt text/x-component text/x-cross-domain-policy text/xml; diff --git a/containers/conf/angie/dhparam.pem b/containers/conf/angie/dhparam.pem new file mode 100644 index 00000000..3cf0fcbc --- /dev/null +++ b/containers/conf/angie/dhparam.pem @@ -0,0 +1,13 @@ +-----BEGIN DH PARAMETERS----- +MIICCAKCAgEA//////////+t+FRYortKmq/cViAnPTzx2LnFg84tNpWp4TZBFGQz ++8yTnc4kmz75fS/jY2MMddj2gbICrsRhetPfHtXV/WVhJDP1H18GbtCFY2VVPe0a +87VXE15/V8k1mE8McODmi3fipona8+/och3xWKE2rec1MKzKT0g6eXq8CrGCsyT7 +YdEIqUuyyOP7uWrat2DX9GgdT0Kj3jlN9K5W7edjcrsZCwenyO4KbXCeAvzhzffi +7MA0BM0oNC9hkXL+nOmFg/+OTxIy7vKBg8P+OxtMb61zO7X8vC7CIAXFjvGDfRaD +ssbzSibBsu/6iGtCOGEfz9zeNVs7ZRkDW7w09N75nAI4YbRvydbmyQd62R0mkff3 +7lmMsPrBhtkcrv4TCYUTknC0EwyTvEN5RPT9RFLi103TZPLiHnH1S/9croKrnJ32 +nuhtK8UiNjoNq8Uhl5sN6todv5pC1cRITgq80Gv6U93vPBsg7j/VnXwl5B0rZp4e +8W5vUsMWTfT7eTDp5OWIV7asfV9C1p9tGHdjzx1VA0AEh/VbpX4xzHpxNciG77Qx +iu1qHgEtnmgyqQdgCpGBMMRtx3j5ca0AOAkpmaMzy4t6Gh25PXFAADwqTs6p+Y0K +zAqCkc3OyX3Pjsm1Wn+IpGtNtahR9EGC4caKAH5eZV9q//////////8CAQI= +-----END DH PARAMETERS----- diff --git a/containers/conf/angie/fastcgi.conf b/containers/conf/angie/fastcgi.conf index d94c2480..f388c050 100755 --- a/containers/conf/angie/fastcgi.conf +++ b/containers/conf/angie/fastcgi.conf @@ -17,4 +17,5 @@ fastcgi_param SERVER_PORT $server_port; fastcgi_param SERVER_PROTOCOL $server_protocol; fastcgi_param SERVER_SOFTWARE nginx/$nginx_version; +fastcgi_hide_header X-Powered-By; fastcgi_index index.php; diff --git a/containers/conf/angie/haikuatelier.conf b/containers/conf/angie/haikuatelier.conf index eacd5c44..3704ac62 100755 --- a/containers/conf/angie/haikuatelier.conf +++ b/containers/conf/angie/haikuatelier.conf @@ -2,15 +2,12 @@ server { listen 80; server_name _; - root /var/www/wordpress/web; + root /var/www/wordpress/web/; index index.html index.php; access_log /var/log/angie/haikuatelier-access.log; error_log /var/log/angie/haikuatelier-error.log; - # Remove X-Powered-By, which is an information leak - fastcgi_hide_header X-Powered-By; - # Pour éviter des erreurs liés à des requêtes trop lourdes. fastcgi_buffers 16 32k; fastcgi_buffer_size 64k; @@ -33,25 +30,27 @@ server { access_log off; } - location ~ \.php$ { - fastcgi_pass wordpress:9000; - fastcgi_split_path_info ^(.+\.php)(/.+)$; - include /etc/angie/fastcgi.conf; - try_files $uri =404; - } - - location ~* .(jpg|jpeg|png|gif|ico|css|js)$ { - expires 365d; - } - location / { try_files $uri $uri/ /index.php?$args; } + location ~ \.php$ { + include /etc/angie/fastcgi.conf; + fastcgi_pass wordpress:9000; + fastcgi_intercept_errors on; + fastcgi_split_path_info ^(.+\.php)(/.+)$; + } + + location ~* \.(?:ico|svg|css|js|gif|jpe?g|png|avif|jxl|webp|avif|woff2?)$ { + access_log off; + expires max; + add_header "Cache-Control" "public, immutable"; + } + location * { - add_header "Access-Control-Allow-Methods" "GET, POST, OPTIONS"; - add_header "Access-Control-Allow-Origin" "*"; - add_header "Cross-Origin-Opener-Policy" "unsafe-none"; - add_header "Cross-Origin-Resource-Policy" "cross-origin"; + add_header "Access-Control-Allow-Methods" "GET, POST, OPTIONS"; + add_header "Access-Control-Allow-Origin" "*"; + add_header "Cross-Origin-Opener-Policy" "unsafe-none"; + add_header "Cross-Origin-Resource-Policy" "cross-origin"; } } diff --git a/containers/conf/angie/naxsi_rules/blocking/10000000_scanner.rules b/containers/conf/angie/naxsi_rules/blocking/10000000_scanner.rules new file mode 100644 index 00000000..3b2e4252 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/10000000_scanner.rules @@ -0,0 +1,96 @@ +####################################### +## Scanners ids: 10000000 ## +####################################### + +# http://pastebin.com/NP64hTQr +# http://blog.initiative-s.de/2013/09/kompromitierte-wordpress-blogs-werden-fuer-ddos-attacken-genutzt/ +# If using wp then turn off this rule +MainRule id:10000000 "s:$UWA:8" "str:wordpress/" "mz:$HEADERS_VAR:User-Agent" "msg:Wordpress in user-agent"; + +# https://github.com/robertdavidgraham/masscan +MainRule id:10000001 "s:$UWA:8" "str:masscan" "mz:$HEADERS_VAR:User-Agent" "msg:masscan in user-agent"; + +# block acunetix scan +MainRule id:10000002 "s:$UWA:8" "str:99999999999999999999999" "mz:$HEADERS_VAR:Content-length" "msg:acunetix scan nginx buffer size"; +MainRule id:10000003 "s:$UWA:8" "str:acunetix" "mz:URL|BODY|$HEADERS_VAR:Accept|$HEADERS_VAR:User-Agent" "msg:acunetix scan website"; +MainRule id:10000004 "s:$UWA:8" "str:acunetix/wvs" "mz:$HEADERS_VAR:Accept" "msg:acunetix scan website"; + +MainRule id:10000005 "s:$UWA:8" "str:havij" "mz:$HEADERS_VAR:User-Agent" "msg:Havij in user-agent"; +MainRule id:10000006 "s:$UWA:8" "str:webmole" "mz:$HEADERS_VAR:User-Agent" "msg:webmole in user-agent"; +MainRule id:10000007 "s:$UWA:8" "str:nlpproject.info" "mz:$HEADERS_VAR:User-Agent" "msg:nlpproject.info in user-agent"; +MainRule id:10000008 "s:$UWA:8" "str:cloudmapping" "mz:$HEADERS_VAR:User-Agent" "msg:cloudmapping in user-agent"; +MainRule id:10000009 "s:$UWA:8" "str:sucuri" "mz:$HEADERS_VAR:User-Agent" "msg:Sucuri in user-agent"; +MainRule id:10000010 "s:$UWA:8" "str:brutus/" "mz:$HEADERS_VAR:User-Agent" "msg:Brutus in user-agent"; +MainRule id:10000011 "s:$UWA:4" "str:apachebench" "mz:$HEADERS_VAR:User-Agent" "msg:apachebench in user-agent"; +MainRule id:10000012 "s:$UWA:8" "str:/netsparker" "mz:URL" "msg:netsparker in user-agent"; +MainRule id:10000013 "s:$UWA:8" "str:mysqloit" "mz:$HEADERS_VAR:User-Agent" "msg:Mysqloit in user-agent"; +MainRule id:10000014 "s:$UWA:8" "str:network-services-auditor" "mz:$HEADERS_VAR:User-Agent" "msg:network-services-auditor in user-agent"; +MainRule id:10000015 "s:$UWA:8" "str:dav.pm" "mz:$HEADERS_VAR:User-Agent" "msg:dav.pm in user-agent"; +MainRule id:10000016 "s:$UWA:8" "str:w3af" "mz:$HEADERS_VAR:User-Agent" "msg:w3af in user-agent"; +MainRule id:10000017 "s:$UWA:8" "str:http_get_vars" "mz:$HEADERS_VAR:User-Agent" "msg:PHP-Injetion on UA"; +MainRule id:10000018 "s:$UWA:8" "str:whisker" "mz:$HEADERS_VAR:User-Agent" "msg:whisker in user-agent"; +MainRule id:10000019 "s:$UWA:8" "str:whatweb" "mz:$HEADERS_VAR:User-Agent" "msg:whatweb in user-agent"; +MainRule id:10000020 "s:$UWA:8" "str:dirbuster" "mz:$HEADERS_VAR:User-Agent" "msg:DirBuster in user-agent"; + +# https://www.bleepingcomputer.com/news/security/phps-git-server-hacked-to-add-backdoors-to-php-source-code/ +# https://github.com/php/php-src/commit/c730aa26bd52829a49f2ad284b181b7e82a68d7d#diff-a35f2ee9e1d2d3983a3270ee10ec70bf86349c53febdeabdf104f88cb2167961R370 +# prevent php supply chain attack +MainRule id:10000021 "s:$UWA:8" "str:zerodium" "mz:$HEADERS_VAR:User-Agent" "msg:zerodium in user-agent"; + +# prevent log4j attack +# info https://www.govcert.ch/blog/zero-day-exploit-targeting-popular-java-library-log4j/ +# payload check https://github.com/johto89/Some-collections-for-Security-Researcher/blob/master/log4j-all-in-one.md +MainRule id:10000022 "s:$UWA:8" "str:${" "mz:$HEADERS_VAR:User-Agent" "msg:log4j attack detection"; + +# Python libraries like python-requests, python-urllib, etc.. +MainRule id:10000023 "s:$UWA:8" "str:python" "mz:$HEADERS_VAR:User-Agent" "msg:python in user-agent"; + +# Meterpreter +MainRule id:10000024 "s:$UWA:8" "str:meterpreter" "mz:$HEADERS_VAR:User-Agent" "msg:meterpreter in user-agent"; + +# https://github.com/zmap/zgrab2 +MainRule id:10000025 "s:$UWA:8" "str:zgrab" "mz:$HEADERS_VAR:User-Agent" "msg:zgrab in user-agent"; + +# Known tools like nmap,curl,wget +MainRule id:10000026 "s:$UWA:8" "str:nmap" "mz:$HEADERS_VAR:User-Agent" "msg:nmap in user-agent"; +MainRule id:10000027 "s:$UWA:8" "str:curl" "mz:$HEADERS_VAR:User-Agent" "msg:curl in user-agent"; +MainRule id:10000028 "s:$UWA:8" "str:wget" "mz:$HEADERS_VAR:User-Agent" "msg:wget in user-agent"; +MainRule id:10000029 "s:$UWA:8" "str:sqlmap" "mz:$HEADERS_VAR:User-Agent" "msg:slqmap in user-agent"; + +# Scan from Expense with this User-Agent: +# Expanse, a Palo Alto Networks company, searches across the global IPv4 space multiple times per day to identify customers presences on the Internet. +# If you would like to be excluded from our scans, please send IP addresses/domains to: scaninfo@paloaltonetworks.com +MainRule id:10000030 "s:$UWA:8" "str:paloaltonetworks.com" "mz:$HEADERS_VAR:User-Agent" "msg:paloaltonetworks in user-agent"; +MainRule id:10000031 "s:$UWA:8" "str:palo alto network" "mz:$HEADERS_VAR:User-Agent" "msg:palo alto network in user-agent"; +MainRule id:10000032 "s:$UWA:8" "str:Expense" "mz:$HEADERS_VAR:User-Agent" "msg:Expense in user-agent"; + +# Scan from NetSystemsResearch with this User-Agent: +# NetSystemsResearch studies the availability of various services across the internet. Our website is netsystemsresearch.com +MainRule id:10000033 "s:$UWA:8" "str:NetSystemsResearch" "mz:$HEADERS_VAR:User-Agent" "msg:NetSystemsResearch in user-agent"; + +# Golang default User-Agent +MainRule id:10000034 "s:$UWA:8" "str:Go-http" "mz:$HEADERS_VAR:User-Agent" "msg:Golang in user-agent"; + +# Perl default User-Agent +MainRule id:10000035 "s:$UWA:8" "str:libwww-perl" "mz:$HEADERS_VAR:User-Agent" "msg:libwww-perl in user-agent"; + +# l9tcpid in User-Agent +MainRule id:10000036 "s:$UWA:8" "str:l9tcpid" "mz:$HEADERS_VAR:User-Agent" "msg:l9tcpid in user-agent"; + +# l9explore in User-Agent +MainRule id:10000037 "s:$UWA:8" "str:l9explore" "mz:$HEADERS_VAR:User-Agent" "msg:l9explore in user-agent"; + +# WPScan in User-Agent +MainRule id:10000038 "s:$UWA:8" "str:wpscan" "mz:$HEADERS_VAR:User-Agent" "msg:WPScan in user-agent"; + +# WinHttpReq in User-Agent +MainRule id:10000039 "s:$UWA:8" "str:WinHttpReq" "mz:$HEADERS_VAR:User-Agent" "msg:WinHttpReq in user-agent"; + +# EgyScan security scanner uses AliElTop in some of the attacks +MainRule id:10000040 "s:$UWA:8" "str:AliElTop" "mz:ANY" "msg:EgyScan security scanner"; + +# Guzzle PHP HTTP client +MainRule id:10000041 "s:$UWA:8" "str:GuzzleHttp" "mz:$HEADERS_VAR:User-Agent" "msg:GuzzleHttp in user-agent"; + +# Java client +MainRule id:10000042 "s:$UWA:8" "str:AsyncHttpClient" "mz:$HEADERS_VAR:User-Agent" "msg:AsyncHttpClient in user-agent"; diff --git a/containers/conf/angie/naxsi_rules/blocking/20000000_web_security.rules b/containers/conf/angie/naxsi_rules/blocking/20000000_web_security.rules new file mode 100644 index 00000000..faa8c493 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/20000000_web_security.rules @@ -0,0 +1,172 @@ +####################################### +## Webserver Security ids: 20000000 ## +####################################### + +# webserver critical files +MainRule id:20000000 "s:$UWA:8" "str:.conf" "mz:URL" "msg:file access to .conf"; +MainRule id:20000001 "s:$UWA:8" "str:.ini" "mz:URL" "msg:file access to .ini"; +MainRule id:20000002 "s:$UWA:8" "str:.sql" "mz:URL" "msg:file access to .sql"; +MainRule id:20000003 "s:$UWA:8" "rx:\.txt$" "mz:URL" "msg:file access to .txt"; +MainRule id:20000004 "s:$UWA:8" "str:/sftp-config.json" "mz:URL|BODY" "msg:file access to sftp-config.json"; +MainRule id:20000005 "s:$UWA:8" "str:/.bzr" "mz:URL" "msg:bazaar version control folder access"; +MainRule id:20000006 "s:$UWA:8" "str:/.git" "mz:URL" "msg:git version control folder access"; +MainRule id:20000007 "s:$UWA:8" "str:/.hg" "mz:URL" "msg:mercurial version control folder access"; +MainRule id:20000008 "s:$UWA:8" "str:/.svn" "mz:URL" "msg:svn version control folder access"; +MainRule id:20000009 "s:$UWA:8" "str:/bzr/" "mz:URL" "msg:bazaar version control folder access"; +MainRule id:20000010 "s:$UWA:8" "str:/git/" "mz:URL" "msg:git version control folder access"; +MainRule id:20000011 "s:$UWA:8" "str:/hg/" "mz:URL" "msg:mercurial version control folder access"; +MainRule id:20000012 "s:$UWA:8" "str:/svn/" "mz:URL" "msg:svn version control folder access"; +MainRule id:20000013 "s:$UWA:8" "str:.htpasswd" "mz:ARGS|BODY|URL|FILE_EXT" "msg:file access to .htpasswd"; +MainRule id:20000014 "s:$UWA:8" "str:.htaccess" "mz:ARGS|BODY|URL|FILE_EXT" "msg:file access to .htaccess"; +MainRule id:20000015 "s:$UWA:8" "str:.ds_store" "mz:URL" "msg:file access to .ds_store"; +MainRule id:20000016 "s:$UWA:8" "str:changelog" "mz:URL" "msg:file access to changelog"; +MainRule id:20000017 "s:$UWA:8" "rx:^/core.\d+$" "mz:URL" "msg:file access to core dumps"; +MainRule id:20000018 "s:$UWA:8" "rx:\.module$" "mz:URL" "msg:file access to .module (drupal)"; +MainRule id:20000019 "s:$UWA:8" "str:web.config" "mz:URL" "msg:file access to web.config (drupal)"; +MainRule id:20000020 "s:$UWA:8" "rx:release[-_]notes\." "mz:URL" "msg:file access to release notes"; +MainRule id:20000021 "s:$UWA:8" "rx:~$" "mz:URL" "msg:file access to cache files"; +MainRule id:20000022 "s:$UWA:8" "str:web-inf" "mz:URL|BODY|ARGS" "msg:folder access to WEB-INF"; + +# Exposed Services +MainRule id:20000023 "s:$UWA:8" "str:/cgi-bin/luci" "mz:URL" "msg:Exposed OpenWRT"; +MainRule id:20000024 "s:$UWA:8" "rx:^/cgi-bin/.+\.cgi$" "mz:URL" "msg:Exposed cgi-bin"; +MainRule id:20000025 "s:$UWA:8" "str:/jenkins" "mz:URL" "msg:Exposed Jenkins"; +MainRule id:20000026 "s:$UWA:8" "str:/console/login/LoginForm.jsp" "mz:URL" "msg:Exposed Oracle WebLogic Server Administration Console"; +MainRule id:20000027 "s:$UWA:8" "str:/nuxeo/login.jsp" "mz:URL" "msg:Exposed Nuxeo Enterprise Platform"; +MainRule id:20000028 "s:$UWA:8" "str:/zabbix/index.php" "mz:URL" "msg:Exposed Zabbix"; + +# Known hacking tools like burp suite, etc.. +MainRule id:20000029 "s:$UWA:8" "str:burpcollaborator.net" "mz:ARGS|BODY|HEADERS" "msg:burp collaborator"; +MainRule id:20000030 "s:$UWA:8" "str:/netsparker" "mz:URL" "msg:Netsparker"; + +# Malicious strings in request +MainRule id:20000031 "s:$UWA:8" "str:\n\r" "mz:URL" "msg:HTTP - Smuggling-Attempt (NewLine in URI)"; +MainRule id:20000032 "s:$UWA:6" "rx:^[a-zA-Z\d-]+\.[a-zA-Z]+$" "mz:$HEADERS_VAR:Host" "msg:HOST-Header Injection"; +MainRule id:20000033 "s:$UWA:8" "str:/bin/sh" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/bin/sh in URI"; +MainRule id:20000034 "s:$UWA:8" "str:/etc/passwd" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/etc/passwd in URI"; +MainRule id:20000035 "s:$UWA:8" "str:/etc/shadow" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/etc/shadow in URI"; +MainRule id:20000036 "s:$UWA:8" "str:/etc/hosts" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/etc/hosts in URI"; +MainRule id:20000037 "s:$UWA:8" "str:/Windows/system.ini" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/Windows/system.ini in URI"; +MainRule id:20000038 "s:$UWA:8" "rx:" "mz:HEADERS" "msg:CVE-2022-22965"; + +# Block Microsoft Exchange Server Remote Code Execution +MainRule id:20000072 "s:$UWA:8" "str:/ecp/Current/exporttool/microsoft.exchange.ediscovery.exporttool.application" "mz:URL" "msg:CVE-2021-28481"; + +# Prevents IndoXploit/IDX Shell dump access +# A website that has been infected will have a world-browsable folder called `idx_config` +# which contains text versions of the configuration file of every CMS installation the shell +# is able to find (impacts WordPress, Joomla and Magento). +MainRule id:20000073 "s:$UWA:8" "str:/idx_config" "mz:URL" "msg:Prevent IndoXploit/IDX Shell dump access"; + +# Prevents old grafana to return all folders +# https://github.com/grafana/grafana/pull/44175 +MainRule id:20000074 "s:$UWA:8" "rx:^0$" "mz:$URL:/api/search|$ARGS_VAR:folderIds" "msg:Access all grafana folders"; + +# Block access to yaml files +MainRule id:20000075 "s:$UWA:8" "str:.yml" "mz:URL" "msg:file access to .yml"; +MainRule id:20000076 "s:$UWA:8" "str:.yaml" "mz:URL" "msg:file access to .yaml"; + +# Block access to HashiCorp Consul/Vault template files +MainRule id:20000077 "s:$UWA:8" "rx:\.ctmpl$" "mz:URL" "msg:file access to .ctmpl"; +MainRule id:20000078 "s:$UWA:8" "rx:\.hcl$" "mz:URL" "msg:file access to .hcl"; + +# Block access to known files used for fingerprinting +MainRule id:20000079 "s:$UWA:8" "rx:\.md$" "mz:URL" "msg:file access to .md"; +MainRule id:20000080 "s:$UWA:8" "rx:read[-_]?me" "mz:URL" "msg:file access to readme"; +MainRule id:20000081 "s:$UWA:8" "rx:\.toml$" "mz:URL" "msg:file access to .toml"; + +# AWS related files +MainRule id:20000082 "s:$UWA:8" "str:dockerrun.aws.json" "mz:URL" "msg:Exposed AWS Elastic Beanstalk configuration"; + +# Block access to temporary backup files like .bak,.bak.php, etc... +MainRule id:20000083 "s:$UWA:8" "str:.bak" "mz:URL" "msg:file access to temporary backup files"; + +# Path traversal in nuxt/framework when in dev mode +# https://huntr.dev/bounties/4849af83-450c-435e-bc0b-71705f5be440/ +MainRule id:20000084 "s:$UWA:8" "str:_nuxt/@" "mz:URL" "msg:path traversal in nuxt framework"; + +# AWS NodeJS related files +MainRule id:20000085 "s:$UWA:8" "str:awsconfig" "mz:URL" "msg:Exposed AWS config files"; +MainRule id:20000086 "s:$UWA:8" "str:aws-config" "mz:URL" "msg:Exposed AWS config files"; +MainRule id:20000087 "s:$UWA:8" "str:awscred" "mz:URL" "msg:Exposed AWS config files"; +MainRule id:20000088 "s:$UWA:8" "str:aws-cred" "mz:URL" "msg:Exposed AWS config files"; + +# Text editors temp and config files +MainRule id:20000089 "s:$UWA:8" "str:.old" "mz:URL" "msg:Exposed temp copy"; +MainRule id:20000090 "s:$UWA:8" "str:.save" "mz:URL" "msg:Exposed temp copy"; +MainRule id:20000091 "s:$UWA:8" "str:.DS_Store" "mz:URL" "msg:Exposed temp copy"; +MainRule id:20000092 "s:$UWA:8" "str:vscode" "mz:URL" "msg:Exposed vscode directory"; + +# Exposed .env +MainRule id:20000093 "s:$UWA:8" "str:/.env" "mz:URL" "msg:access to .env file or dir"; + +# androxgh0st exploit +MainRule id:20000094 "s:$UWA:8" "str:androxgh0st" "mz:ANY" "msg:androxgh0st exploit"; diff --git a/containers/conf/angie/naxsi_rules/blocking/30000000_wordpress.rules b/containers/conf/angie/naxsi_rules/blocking/30000000_wordpress.rules new file mode 100644 index 00000000..bb66f6af --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/30000000_wordpress.rules @@ -0,0 +1,16 @@ +####################################### +## Wordpress ids: 30000000 ## +####################################### + +MainRule id:30000000 "s:$UWA:8" "str:system.multicall" "mz:$URL:/xmlrpc.php|BODY" "msg:Wordpress XMLRPC possible Password Brute Force"; +MainRule id:30000001 "s:$UWA:8" "str:system.listmethods" "mz:$URL:/xmlrpc.php|BODY" "msg:WordPress XMLRPC Enumeration system.listMethods"; +MainRule id:30000002 "s:$UWA:8" "str:system.getcapabilities" "mz:$URL:/xmlrpc.php|BODY" "msg:WordPress XMLRPC Enumeration system.getCapabilities"; +MainRule id:30000003 "s:$UWA:8" "str:/w3tc/dbcache" "mz:URL" "msg:WordPress TotalCache-DBCache-Access"; +MainRule id:30000004 "s:$UWA:8" "str:/uploadify/uploadify.php" "mz:URL" "msg:WordPress Uploadify-Access"; +MainRule id:30000005 "s:$UWA:8" "str:/wp-content/plugins/mm-forms-community/upload/temp/" "mz:URL" "msg:Access To mm-forms-community upload dir"; +MainRule id:30000006 "s:$UWA:8" "str:wp-config.php" "mz:BODY|ARGS|URL" "msg:WordPress access to wp-config.php"; + +# block malicious access ALFA_DATA|alfacgiapi|cgialfa path +MainRule id:30000007 "s:$UWA:8" "str:ALFA_DATA" "mz:URL" "msg:WordPress malicious access to ALFA_DATA path"; +MainRule id:30000008 "s:$UWA:8" "str:alfacgiapi" "mz:URL" "msg:WordPress malicious access to alfacgiapi path"; +MainRule id:30000009 "s:$UWA:8" "str:cgialfa" "mz:URL" "msg:WordPress malicious access to cgialfa path"; diff --git a/containers/conf/angie/naxsi_rules/blocking/40000000_php_security.rules b/containers/conf/angie/naxsi_rules/blocking/40000000_php_security.rules new file mode 100644 index 00000000..34be94e5 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/40000000_php_security.rules @@ -0,0 +1,66 @@ +####################################### +## PHP Security ids: 40000000 ## +####################################### + +# Php Functions +MainRule id:40000000 "s:$UWA:8" "str:gzinflate(" "mz:URL|BODY|ARGS" "msg:gzinflate in URI"; +MainRule id:40000001 "s:$UWA:8" "str:system(" "mz:URL|BODY|ARGS" "msg:php system called"; +MainRule id:40000002 "s:$UWA:8" "str:base64_decode(" "mz:URL|BODY|ARGS" "msg:php base64_decode called"; +MainRule id:40000003 "s:$UWA:8" "str:@eval" "mz:URL|BODY|ARGS" "msg:php eval called"; +MainRule id:40000004 "s:$UWA:8" "rx:eval\((\s+)?\$_" "mz:URL|BODY|ARGS" "msg:php eval called"; + +# PhpMyAdmin +MainRule id:40000005 "s:$UWA:8" "str:/db-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000006 "s:$UWA:8" "str:/dbadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000007 "s:$UWA:8" "str:/myadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000008 "s:$UWA:8" "str:/mysqldumper " "mz:URL" "msg:MysqlDumper"; +MainRule id:40000009 "s:$UWA:8" "str:/mysqlmanager" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000010 "s:$UWA:8" "str:/p/m/a/" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000011 "s:$UWA:8" "str:/php-my-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000012 "s:$UWA:8" "str:/php-myadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000013 "s:$UWA:8" "str:/phpmanager" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000014 "s:$UWA:8" "str:/phpmy" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000015 "s:$UWA:8" "str:/phpmy-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000016 "s:$UWA:8" "str:/phpmyadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000017 "s:$UWA:8" "str:/phppgadmin " "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000018 "s:$UWA:8" "str:/pma" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000019 "s:$UWA:8" "str:/sql-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000020 "s:$UWA:8" "str:/sqladmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000021 "s:$UWA:8" "str:/sqlweb" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000022 "s:$UWA:8" "str:/sysadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000023 "s:$UWA:8" "str:/webadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000024 "s:$UWA:8" "str:/webdb" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000025 "s:$UWA:8" "str:/websql" "mz:URL" "msg:SQL Admin Interface"; + +# Block PHPUnit eval-stdin.php CVE-2017-9841 +MainRule id:40000026 "s:$UWA:8" "str:eval-stdin.php" "mz:URL" "msg:CVE-2017-9841"; + +# Block PHP easter egg which normally can be disabled via expose_php = off +MainRule id:40000027 "s:$UWA:8" "rx:PHP[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" "mz:URL|BODY|ARGS" "msg:PHP easter egg credits"; + +# Block PHP Xdebug +MainRule id:40000028 "s:$UWA:8" "str:XDEBUG_SESSION" "mz:ANY" "msg:Block PHP Xdebug"; + +# Block PHPinfo access +MainRule id:40000029 "s:$UWA:8" "str:phpinfo" "mz:URL|BODY|ARGS" "msg:PHPinfo access"; + +# Block known php installer exploit +MainRule id:40000030 "s:$UWA:8" "str:install.php" "mz:URL" "msg:Access to php install"; + +# Block more sql admin interface +MainRule id:40000031 "s:$UWA:8" "str:/mysql-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000032 "s:$UWA:8" "str:/mysqladmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000033 "s:$UWA:8" "str:/sqlmanager" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000034 "s:$UWA:8" "str:/mysql/" "mz:URL" "msg:SQL Admin Interface"; + +# Block access to Lavarel telescope since it allows to read logs and SQL queries +MainRule id:40000035 "s:$UWA:8" "str:/telescope/" "mz:URL" "msg:Access to Lavarel telescope"; + +# Block access to adminer/phpMinAdmin sql admin interface +MainRule id:40000036 "s:$UWA:8" "str:adminer" "mz:URL" "msg:SQL Admin Interface"; + +# Block access to Symfony Web Framework dev mode. +MainRule id:40000037 "s:$UWA:8" "str:app_dev" "mz:URL" "msg:Symfony Web Framework dev mode"; + +# phpstorm in request +MainRule id:40000038 "s:$UWA:8" "str:phpstorm" "mz:URL|ARGS|HEADERS" "msg:phpstorm in request"; diff --git a/containers/conf/angie/naxsi_rules/blocking/blocking/10000000_scanner.rules b/containers/conf/angie/naxsi_rules/blocking/blocking/10000000_scanner.rules new file mode 100644 index 00000000..3b2e4252 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/blocking/10000000_scanner.rules @@ -0,0 +1,96 @@ +####################################### +## Scanners ids: 10000000 ## +####################################### + +# http://pastebin.com/NP64hTQr +# http://blog.initiative-s.de/2013/09/kompromitierte-wordpress-blogs-werden-fuer-ddos-attacken-genutzt/ +# If using wp then turn off this rule +MainRule id:10000000 "s:$UWA:8" "str:wordpress/" "mz:$HEADERS_VAR:User-Agent" "msg:Wordpress in user-agent"; + +# https://github.com/robertdavidgraham/masscan +MainRule id:10000001 "s:$UWA:8" "str:masscan" "mz:$HEADERS_VAR:User-Agent" "msg:masscan in user-agent"; + +# block acunetix scan +MainRule id:10000002 "s:$UWA:8" "str:99999999999999999999999" "mz:$HEADERS_VAR:Content-length" "msg:acunetix scan nginx buffer size"; +MainRule id:10000003 "s:$UWA:8" "str:acunetix" "mz:URL|BODY|$HEADERS_VAR:Accept|$HEADERS_VAR:User-Agent" "msg:acunetix scan website"; +MainRule id:10000004 "s:$UWA:8" "str:acunetix/wvs" "mz:$HEADERS_VAR:Accept" "msg:acunetix scan website"; + +MainRule id:10000005 "s:$UWA:8" "str:havij" "mz:$HEADERS_VAR:User-Agent" "msg:Havij in user-agent"; +MainRule id:10000006 "s:$UWA:8" "str:webmole" "mz:$HEADERS_VAR:User-Agent" "msg:webmole in user-agent"; +MainRule id:10000007 "s:$UWA:8" "str:nlpproject.info" "mz:$HEADERS_VAR:User-Agent" "msg:nlpproject.info in user-agent"; +MainRule id:10000008 "s:$UWA:8" "str:cloudmapping" "mz:$HEADERS_VAR:User-Agent" "msg:cloudmapping in user-agent"; +MainRule id:10000009 "s:$UWA:8" "str:sucuri" "mz:$HEADERS_VAR:User-Agent" "msg:Sucuri in user-agent"; +MainRule id:10000010 "s:$UWA:8" "str:brutus/" "mz:$HEADERS_VAR:User-Agent" "msg:Brutus in user-agent"; +MainRule id:10000011 "s:$UWA:4" "str:apachebench" "mz:$HEADERS_VAR:User-Agent" "msg:apachebench in user-agent"; +MainRule id:10000012 "s:$UWA:8" "str:/netsparker" "mz:URL" "msg:netsparker in user-agent"; +MainRule id:10000013 "s:$UWA:8" "str:mysqloit" "mz:$HEADERS_VAR:User-Agent" "msg:Mysqloit in user-agent"; +MainRule id:10000014 "s:$UWA:8" "str:network-services-auditor" "mz:$HEADERS_VAR:User-Agent" "msg:network-services-auditor in user-agent"; +MainRule id:10000015 "s:$UWA:8" "str:dav.pm" "mz:$HEADERS_VAR:User-Agent" "msg:dav.pm in user-agent"; +MainRule id:10000016 "s:$UWA:8" "str:w3af" "mz:$HEADERS_VAR:User-Agent" "msg:w3af in user-agent"; +MainRule id:10000017 "s:$UWA:8" "str:http_get_vars" "mz:$HEADERS_VAR:User-Agent" "msg:PHP-Injetion on UA"; +MainRule id:10000018 "s:$UWA:8" "str:whisker" "mz:$HEADERS_VAR:User-Agent" "msg:whisker in user-agent"; +MainRule id:10000019 "s:$UWA:8" "str:whatweb" "mz:$HEADERS_VAR:User-Agent" "msg:whatweb in user-agent"; +MainRule id:10000020 "s:$UWA:8" "str:dirbuster" "mz:$HEADERS_VAR:User-Agent" "msg:DirBuster in user-agent"; + +# https://www.bleepingcomputer.com/news/security/phps-git-server-hacked-to-add-backdoors-to-php-source-code/ +# https://github.com/php/php-src/commit/c730aa26bd52829a49f2ad284b181b7e82a68d7d#diff-a35f2ee9e1d2d3983a3270ee10ec70bf86349c53febdeabdf104f88cb2167961R370 +# prevent php supply chain attack +MainRule id:10000021 "s:$UWA:8" "str:zerodium" "mz:$HEADERS_VAR:User-Agent" "msg:zerodium in user-agent"; + +# prevent log4j attack +# info https://www.govcert.ch/blog/zero-day-exploit-targeting-popular-java-library-log4j/ +# payload check https://github.com/johto89/Some-collections-for-Security-Researcher/blob/master/log4j-all-in-one.md +MainRule id:10000022 "s:$UWA:8" "str:${" "mz:$HEADERS_VAR:User-Agent" "msg:log4j attack detection"; + +# Python libraries like python-requests, python-urllib, etc.. +MainRule id:10000023 "s:$UWA:8" "str:python" "mz:$HEADERS_VAR:User-Agent" "msg:python in user-agent"; + +# Meterpreter +MainRule id:10000024 "s:$UWA:8" "str:meterpreter" "mz:$HEADERS_VAR:User-Agent" "msg:meterpreter in user-agent"; + +# https://github.com/zmap/zgrab2 +MainRule id:10000025 "s:$UWA:8" "str:zgrab" "mz:$HEADERS_VAR:User-Agent" "msg:zgrab in user-agent"; + +# Known tools like nmap,curl,wget +MainRule id:10000026 "s:$UWA:8" "str:nmap" "mz:$HEADERS_VAR:User-Agent" "msg:nmap in user-agent"; +MainRule id:10000027 "s:$UWA:8" "str:curl" "mz:$HEADERS_VAR:User-Agent" "msg:curl in user-agent"; +MainRule id:10000028 "s:$UWA:8" "str:wget" "mz:$HEADERS_VAR:User-Agent" "msg:wget in user-agent"; +MainRule id:10000029 "s:$UWA:8" "str:sqlmap" "mz:$HEADERS_VAR:User-Agent" "msg:slqmap in user-agent"; + +# Scan from Expense with this User-Agent: +# Expanse, a Palo Alto Networks company, searches across the global IPv4 space multiple times per day to identify customers presences on the Internet. +# If you would like to be excluded from our scans, please send IP addresses/domains to: scaninfo@paloaltonetworks.com +MainRule id:10000030 "s:$UWA:8" "str:paloaltonetworks.com" "mz:$HEADERS_VAR:User-Agent" "msg:paloaltonetworks in user-agent"; +MainRule id:10000031 "s:$UWA:8" "str:palo alto network" "mz:$HEADERS_VAR:User-Agent" "msg:palo alto network in user-agent"; +MainRule id:10000032 "s:$UWA:8" "str:Expense" "mz:$HEADERS_VAR:User-Agent" "msg:Expense in user-agent"; + +# Scan from NetSystemsResearch with this User-Agent: +# NetSystemsResearch studies the availability of various services across the internet. Our website is netsystemsresearch.com +MainRule id:10000033 "s:$UWA:8" "str:NetSystemsResearch" "mz:$HEADERS_VAR:User-Agent" "msg:NetSystemsResearch in user-agent"; + +# Golang default User-Agent +MainRule id:10000034 "s:$UWA:8" "str:Go-http" "mz:$HEADERS_VAR:User-Agent" "msg:Golang in user-agent"; + +# Perl default User-Agent +MainRule id:10000035 "s:$UWA:8" "str:libwww-perl" "mz:$HEADERS_VAR:User-Agent" "msg:libwww-perl in user-agent"; + +# l9tcpid in User-Agent +MainRule id:10000036 "s:$UWA:8" "str:l9tcpid" "mz:$HEADERS_VAR:User-Agent" "msg:l9tcpid in user-agent"; + +# l9explore in User-Agent +MainRule id:10000037 "s:$UWA:8" "str:l9explore" "mz:$HEADERS_VAR:User-Agent" "msg:l9explore in user-agent"; + +# WPScan in User-Agent +MainRule id:10000038 "s:$UWA:8" "str:wpscan" "mz:$HEADERS_VAR:User-Agent" "msg:WPScan in user-agent"; + +# WinHttpReq in User-Agent +MainRule id:10000039 "s:$UWA:8" "str:WinHttpReq" "mz:$HEADERS_VAR:User-Agent" "msg:WinHttpReq in user-agent"; + +# EgyScan security scanner uses AliElTop in some of the attacks +MainRule id:10000040 "s:$UWA:8" "str:AliElTop" "mz:ANY" "msg:EgyScan security scanner"; + +# Guzzle PHP HTTP client +MainRule id:10000041 "s:$UWA:8" "str:GuzzleHttp" "mz:$HEADERS_VAR:User-Agent" "msg:GuzzleHttp in user-agent"; + +# Java client +MainRule id:10000042 "s:$UWA:8" "str:AsyncHttpClient" "mz:$HEADERS_VAR:User-Agent" "msg:AsyncHttpClient in user-agent"; diff --git a/containers/conf/angie/naxsi_rules/blocking/blocking/20000000_web_security.rules b/containers/conf/angie/naxsi_rules/blocking/blocking/20000000_web_security.rules new file mode 100644 index 00000000..faa8c493 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/blocking/20000000_web_security.rules @@ -0,0 +1,172 @@ +####################################### +## Webserver Security ids: 20000000 ## +####################################### + +# webserver critical files +MainRule id:20000000 "s:$UWA:8" "str:.conf" "mz:URL" "msg:file access to .conf"; +MainRule id:20000001 "s:$UWA:8" "str:.ini" "mz:URL" "msg:file access to .ini"; +MainRule id:20000002 "s:$UWA:8" "str:.sql" "mz:URL" "msg:file access to .sql"; +MainRule id:20000003 "s:$UWA:8" "rx:\.txt$" "mz:URL" "msg:file access to .txt"; +MainRule id:20000004 "s:$UWA:8" "str:/sftp-config.json" "mz:URL|BODY" "msg:file access to sftp-config.json"; +MainRule id:20000005 "s:$UWA:8" "str:/.bzr" "mz:URL" "msg:bazaar version control folder access"; +MainRule id:20000006 "s:$UWA:8" "str:/.git" "mz:URL" "msg:git version control folder access"; +MainRule id:20000007 "s:$UWA:8" "str:/.hg" "mz:URL" "msg:mercurial version control folder access"; +MainRule id:20000008 "s:$UWA:8" "str:/.svn" "mz:URL" "msg:svn version control folder access"; +MainRule id:20000009 "s:$UWA:8" "str:/bzr/" "mz:URL" "msg:bazaar version control folder access"; +MainRule id:20000010 "s:$UWA:8" "str:/git/" "mz:URL" "msg:git version control folder access"; +MainRule id:20000011 "s:$UWA:8" "str:/hg/" "mz:URL" "msg:mercurial version control folder access"; +MainRule id:20000012 "s:$UWA:8" "str:/svn/" "mz:URL" "msg:svn version control folder access"; +MainRule id:20000013 "s:$UWA:8" "str:.htpasswd" "mz:ARGS|BODY|URL|FILE_EXT" "msg:file access to .htpasswd"; +MainRule id:20000014 "s:$UWA:8" "str:.htaccess" "mz:ARGS|BODY|URL|FILE_EXT" "msg:file access to .htaccess"; +MainRule id:20000015 "s:$UWA:8" "str:.ds_store" "mz:URL" "msg:file access to .ds_store"; +MainRule id:20000016 "s:$UWA:8" "str:changelog" "mz:URL" "msg:file access to changelog"; +MainRule id:20000017 "s:$UWA:8" "rx:^/core.\d+$" "mz:URL" "msg:file access to core dumps"; +MainRule id:20000018 "s:$UWA:8" "rx:\.module$" "mz:URL" "msg:file access to .module (drupal)"; +MainRule id:20000019 "s:$UWA:8" "str:web.config" "mz:URL" "msg:file access to web.config (drupal)"; +MainRule id:20000020 "s:$UWA:8" "rx:release[-_]notes\." "mz:URL" "msg:file access to release notes"; +MainRule id:20000021 "s:$UWA:8" "rx:~$" "mz:URL" "msg:file access to cache files"; +MainRule id:20000022 "s:$UWA:8" "str:web-inf" "mz:URL|BODY|ARGS" "msg:folder access to WEB-INF"; + +# Exposed Services +MainRule id:20000023 "s:$UWA:8" "str:/cgi-bin/luci" "mz:URL" "msg:Exposed OpenWRT"; +MainRule id:20000024 "s:$UWA:8" "rx:^/cgi-bin/.+\.cgi$" "mz:URL" "msg:Exposed cgi-bin"; +MainRule id:20000025 "s:$UWA:8" "str:/jenkins" "mz:URL" "msg:Exposed Jenkins"; +MainRule id:20000026 "s:$UWA:8" "str:/console/login/LoginForm.jsp" "mz:URL" "msg:Exposed Oracle WebLogic Server Administration Console"; +MainRule id:20000027 "s:$UWA:8" "str:/nuxeo/login.jsp" "mz:URL" "msg:Exposed Nuxeo Enterprise Platform"; +MainRule id:20000028 "s:$UWA:8" "str:/zabbix/index.php" "mz:URL" "msg:Exposed Zabbix"; + +# Known hacking tools like burp suite, etc.. +MainRule id:20000029 "s:$UWA:8" "str:burpcollaborator.net" "mz:ARGS|BODY|HEADERS" "msg:burp collaborator"; +MainRule id:20000030 "s:$UWA:8" "str:/netsparker" "mz:URL" "msg:Netsparker"; + +# Malicious strings in request +MainRule id:20000031 "s:$UWA:8" "str:\n\r" "mz:URL" "msg:HTTP - Smuggling-Attempt (NewLine in URI)"; +MainRule id:20000032 "s:$UWA:6" "rx:^[a-zA-Z\d-]+\.[a-zA-Z]+$" "mz:$HEADERS_VAR:Host" "msg:HOST-Header Injection"; +MainRule id:20000033 "s:$UWA:8" "str:/bin/sh" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/bin/sh in URI"; +MainRule id:20000034 "s:$UWA:8" "str:/etc/passwd" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/etc/passwd in URI"; +MainRule id:20000035 "s:$UWA:8" "str:/etc/shadow" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/etc/shadow in URI"; +MainRule id:20000036 "s:$UWA:8" "str:/etc/hosts" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/etc/hosts in URI"; +MainRule id:20000037 "s:$UWA:8" "str:/Windows/system.ini" "mz:URL|BODY|ARGS|$HEADERS_VAR:User-Agent|$HEADERS_VAR:Cookie" "msg:/Windows/system.ini in URI"; +MainRule id:20000038 "s:$UWA:8" "rx:" "mz:HEADERS" "msg:CVE-2022-22965"; + +# Block Microsoft Exchange Server Remote Code Execution +MainRule id:20000072 "s:$UWA:8" "str:/ecp/Current/exporttool/microsoft.exchange.ediscovery.exporttool.application" "mz:URL" "msg:CVE-2021-28481"; + +# Prevents IndoXploit/IDX Shell dump access +# A website that has been infected will have a world-browsable folder called `idx_config` +# which contains text versions of the configuration file of every CMS installation the shell +# is able to find (impacts WordPress, Joomla and Magento). +MainRule id:20000073 "s:$UWA:8" "str:/idx_config" "mz:URL" "msg:Prevent IndoXploit/IDX Shell dump access"; + +# Prevents old grafana to return all folders +# https://github.com/grafana/grafana/pull/44175 +MainRule id:20000074 "s:$UWA:8" "rx:^0$" "mz:$URL:/api/search|$ARGS_VAR:folderIds" "msg:Access all grafana folders"; + +# Block access to yaml files +MainRule id:20000075 "s:$UWA:8" "str:.yml" "mz:URL" "msg:file access to .yml"; +MainRule id:20000076 "s:$UWA:8" "str:.yaml" "mz:URL" "msg:file access to .yaml"; + +# Block access to HashiCorp Consul/Vault template files +MainRule id:20000077 "s:$UWA:8" "rx:\.ctmpl$" "mz:URL" "msg:file access to .ctmpl"; +MainRule id:20000078 "s:$UWA:8" "rx:\.hcl$" "mz:URL" "msg:file access to .hcl"; + +# Block access to known files used for fingerprinting +MainRule id:20000079 "s:$UWA:8" "rx:\.md$" "mz:URL" "msg:file access to .md"; +MainRule id:20000080 "s:$UWA:8" "rx:read[-_]?me" "mz:URL" "msg:file access to readme"; +MainRule id:20000081 "s:$UWA:8" "rx:\.toml$" "mz:URL" "msg:file access to .toml"; + +# AWS related files +MainRule id:20000082 "s:$UWA:8" "str:dockerrun.aws.json" "mz:URL" "msg:Exposed AWS Elastic Beanstalk configuration"; + +# Block access to temporary backup files like .bak,.bak.php, etc... +MainRule id:20000083 "s:$UWA:8" "str:.bak" "mz:URL" "msg:file access to temporary backup files"; + +# Path traversal in nuxt/framework when in dev mode +# https://huntr.dev/bounties/4849af83-450c-435e-bc0b-71705f5be440/ +MainRule id:20000084 "s:$UWA:8" "str:_nuxt/@" "mz:URL" "msg:path traversal in nuxt framework"; + +# AWS NodeJS related files +MainRule id:20000085 "s:$UWA:8" "str:awsconfig" "mz:URL" "msg:Exposed AWS config files"; +MainRule id:20000086 "s:$UWA:8" "str:aws-config" "mz:URL" "msg:Exposed AWS config files"; +MainRule id:20000087 "s:$UWA:8" "str:awscred" "mz:URL" "msg:Exposed AWS config files"; +MainRule id:20000088 "s:$UWA:8" "str:aws-cred" "mz:URL" "msg:Exposed AWS config files"; + +# Text editors temp and config files +MainRule id:20000089 "s:$UWA:8" "str:.old" "mz:URL" "msg:Exposed temp copy"; +MainRule id:20000090 "s:$UWA:8" "str:.save" "mz:URL" "msg:Exposed temp copy"; +MainRule id:20000091 "s:$UWA:8" "str:.DS_Store" "mz:URL" "msg:Exposed temp copy"; +MainRule id:20000092 "s:$UWA:8" "str:vscode" "mz:URL" "msg:Exposed vscode directory"; + +# Exposed .env +MainRule id:20000093 "s:$UWA:8" "str:/.env" "mz:URL" "msg:access to .env file or dir"; + +# androxgh0st exploit +MainRule id:20000094 "s:$UWA:8" "str:androxgh0st" "mz:ANY" "msg:androxgh0st exploit"; diff --git a/containers/conf/angie/naxsi_rules/blocking/blocking/30000000_wordpress.rules b/containers/conf/angie/naxsi_rules/blocking/blocking/30000000_wordpress.rules new file mode 100644 index 00000000..bb66f6af --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/blocking/30000000_wordpress.rules @@ -0,0 +1,16 @@ +####################################### +## Wordpress ids: 30000000 ## +####################################### + +MainRule id:30000000 "s:$UWA:8" "str:system.multicall" "mz:$URL:/xmlrpc.php|BODY" "msg:Wordpress XMLRPC possible Password Brute Force"; +MainRule id:30000001 "s:$UWA:8" "str:system.listmethods" "mz:$URL:/xmlrpc.php|BODY" "msg:WordPress XMLRPC Enumeration system.listMethods"; +MainRule id:30000002 "s:$UWA:8" "str:system.getcapabilities" "mz:$URL:/xmlrpc.php|BODY" "msg:WordPress XMLRPC Enumeration system.getCapabilities"; +MainRule id:30000003 "s:$UWA:8" "str:/w3tc/dbcache" "mz:URL" "msg:WordPress TotalCache-DBCache-Access"; +MainRule id:30000004 "s:$UWA:8" "str:/uploadify/uploadify.php" "mz:URL" "msg:WordPress Uploadify-Access"; +MainRule id:30000005 "s:$UWA:8" "str:/wp-content/plugins/mm-forms-community/upload/temp/" "mz:URL" "msg:Access To mm-forms-community upload dir"; +MainRule id:30000006 "s:$UWA:8" "str:wp-config.php" "mz:BODY|ARGS|URL" "msg:WordPress access to wp-config.php"; + +# block malicious access ALFA_DATA|alfacgiapi|cgialfa path +MainRule id:30000007 "s:$UWA:8" "str:ALFA_DATA" "mz:URL" "msg:WordPress malicious access to ALFA_DATA path"; +MainRule id:30000008 "s:$UWA:8" "str:alfacgiapi" "mz:URL" "msg:WordPress malicious access to alfacgiapi path"; +MainRule id:30000009 "s:$UWA:8" "str:cgialfa" "mz:URL" "msg:WordPress malicious access to cgialfa path"; diff --git a/containers/conf/angie/naxsi_rules/blocking/blocking/40000000_php_security.rules b/containers/conf/angie/naxsi_rules/blocking/blocking/40000000_php_security.rules new file mode 100644 index 00000000..34be94e5 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/blocking/40000000_php_security.rules @@ -0,0 +1,66 @@ +####################################### +## PHP Security ids: 40000000 ## +####################################### + +# Php Functions +MainRule id:40000000 "s:$UWA:8" "str:gzinflate(" "mz:URL|BODY|ARGS" "msg:gzinflate in URI"; +MainRule id:40000001 "s:$UWA:8" "str:system(" "mz:URL|BODY|ARGS" "msg:php system called"; +MainRule id:40000002 "s:$UWA:8" "str:base64_decode(" "mz:URL|BODY|ARGS" "msg:php base64_decode called"; +MainRule id:40000003 "s:$UWA:8" "str:@eval" "mz:URL|BODY|ARGS" "msg:php eval called"; +MainRule id:40000004 "s:$UWA:8" "rx:eval\((\s+)?\$_" "mz:URL|BODY|ARGS" "msg:php eval called"; + +# PhpMyAdmin +MainRule id:40000005 "s:$UWA:8" "str:/db-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000006 "s:$UWA:8" "str:/dbadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000007 "s:$UWA:8" "str:/myadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000008 "s:$UWA:8" "str:/mysqldumper " "mz:URL" "msg:MysqlDumper"; +MainRule id:40000009 "s:$UWA:8" "str:/mysqlmanager" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000010 "s:$UWA:8" "str:/p/m/a/" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000011 "s:$UWA:8" "str:/php-my-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000012 "s:$UWA:8" "str:/php-myadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000013 "s:$UWA:8" "str:/phpmanager" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000014 "s:$UWA:8" "str:/phpmy" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000015 "s:$UWA:8" "str:/phpmy-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000016 "s:$UWA:8" "str:/phpmyadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000017 "s:$UWA:8" "str:/phppgadmin " "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000018 "s:$UWA:8" "str:/pma" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000019 "s:$UWA:8" "str:/sql-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000020 "s:$UWA:8" "str:/sqladmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000021 "s:$UWA:8" "str:/sqlweb" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000022 "s:$UWA:8" "str:/sysadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000023 "s:$UWA:8" "str:/webadmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000024 "s:$UWA:8" "str:/webdb" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000025 "s:$UWA:8" "str:/websql" "mz:URL" "msg:SQL Admin Interface"; + +# Block PHPUnit eval-stdin.php CVE-2017-9841 +MainRule id:40000026 "s:$UWA:8" "str:eval-stdin.php" "mz:URL" "msg:CVE-2017-9841"; + +# Block PHP easter egg which normally can be disabled via expose_php = off +MainRule id:40000027 "s:$UWA:8" "rx:PHP[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" "mz:URL|BODY|ARGS" "msg:PHP easter egg credits"; + +# Block PHP Xdebug +MainRule id:40000028 "s:$UWA:8" "str:XDEBUG_SESSION" "mz:ANY" "msg:Block PHP Xdebug"; + +# Block PHPinfo access +MainRule id:40000029 "s:$UWA:8" "str:phpinfo" "mz:URL|BODY|ARGS" "msg:PHPinfo access"; + +# Block known php installer exploit +MainRule id:40000030 "s:$UWA:8" "str:install.php" "mz:URL" "msg:Access to php install"; + +# Block more sql admin interface +MainRule id:40000031 "s:$UWA:8" "str:/mysql-admin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000032 "s:$UWA:8" "str:/mysqladmin" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000033 "s:$UWA:8" "str:/sqlmanager" "mz:URL" "msg:SQL Admin Interface"; +MainRule id:40000034 "s:$UWA:8" "str:/mysql/" "mz:URL" "msg:SQL Admin Interface"; + +# Block access to Lavarel telescope since it allows to read logs and SQL queries +MainRule id:40000035 "s:$UWA:8" "str:/telescope/" "mz:URL" "msg:Access to Lavarel telescope"; + +# Block access to adminer/phpMinAdmin sql admin interface +MainRule id:40000036 "s:$UWA:8" "str:adminer" "mz:URL" "msg:SQL Admin Interface"; + +# Block access to Symfony Web Framework dev mode. +MainRule id:40000037 "s:$UWA:8" "str:app_dev" "mz:URL" "msg:Symfony Web Framework dev mode"; + +# phpstorm in request +MainRule id:40000038 "s:$UWA:8" "str:phpstorm" "mz:URL|ARGS|HEADERS" "msg:phpstorm in request"; diff --git a/containers/conf/angie/naxsi_rules/blocking/blocking/50000000_sql_injection.rules b/containers/conf/angie/naxsi_rules/blocking/blocking/50000000_sql_injection.rules new file mode 100644 index 00000000..3d584e03 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/blocking/blocking/50000000_sql_injection.rules @@ -0,0 +1,15 @@ +####################################### +## SQL Injection ids: 50000000 ## +####################################### + +# Transact-SQL General Extended Stored Procedures +# https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/general-extended-stored-procedures-transact-sql +MainRule id:50000000 "s:$SQL:8" "rx:xp_(cmdshell|enumgroups|grantlogin|logevent|loginconfig|logininfo|msver|revokelogin|sprintf|sqlmaint|sscanf)" "mz:BODY|HEADERS|ARGS|URL" "msg:Transact-SQL GESP"; + +# Classic SQL injection +MainRule id:50000001 "s:$SQL:8" "rx:(CHAR|CONCAT|CONCAT_WS)\([0-9a-fx,]+\)" "mz:BODY|HEADERS|ARGS|URL" "msg:SQL Injection"; +MainRule id:50000002 "s:$SQL:8" "rx:SLEEP(\s+)?\(" "mz:BODY|HEADERS|ARGS|URL" "msg:SQL Injection"; +MainRule id:50000003 "s:$SQL:8" "rx:\bBENCHMARK\b\([0-9,]+.+\)" "mz:BODY|HEADERS|ARGS|URL" "msg:SQL Injection"; +MainRule id:50000004 "s:$SQL:8" "rx:\b(UNION|INFORMATION_SCHEMA)\b.*(#|--|\*)" "mz:BODY|HEADERS|ARGS|URL" "msg:SQL Injection"; +MainRule id:50000005 "s:$SQL:8" "rx:(MD\d|SHA\d+)(\s+)?\(" "mz:BODY|HEADERS|ARGS|URL" "msg:SQL Injection"; +MainRule id:50000006 "s:$SQL:8" "rx:DBMS_PIPE|RECEIVE_MESSAGE|WAITFOR|DELAY" "mz:BODY|HEADERS|ARGS|URL" "msg:SQL Injection"; diff --git a/containers/conf/angie/naxsi_rules/naxsi_core.rules b/containers/conf/angie/naxsi_rules/naxsi_core.rules new file mode 100644 index 00000000..6a39d255 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/naxsi_core.rules @@ -0,0 +1,95 @@ +################################## +## INTERNAL RULES IDS:1-999 ## +################################## +#@MainRule "msg:weird request, unable to parse" id:1; +#@MainRule "msg:request too big, stored on disk and not parsed" id:2; +#@MainRule "msg:invalid hex encoding, null bytes" id:10; +#@MainRule "msg:unknown content-type" id:11; +#@MainRule "msg:invalid formatted url" id:12; +#@MainRule "msg:invalid POST format" id:13; +#@MainRule "msg:invalid POST boundary" id:14; +#@MainRule "msg:invalid JSON" id:15; +#@MainRule "msg:empty POST" id:16; +#@MainRule "msg:libinjection_sql" id:17; +#@MainRule "msg:libinjection_xss" id:18; +#@MainRule "msg:no generic rules" id:19; +#@MainRule "msg:bad utf8" id:20; +#@MainRule "msg:illegal host header" id:21; + +################################## +## SQL Injections IDs:1000-1099 ## +################################## +MainRule "rx:select|union|update|delete|insert|table|from|ascii|hex|unhex|drop|load_file|substr|group_concat|dumpfile|bigint" "msg:sql keywords" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:4" id:1000; +MainRule "str:\"" "msg:double quote" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:8,$XSS:8" id:1001; +MainRule "str:0x" "msg:0x, possible hex encoding" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:2" id:1002; +## Hardcore rules +MainRule "str:/*" "msg:mysql comment (/*)" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:8" id:1003; +MainRule "str:*/" "msg:mysql comment (*/)" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:8" id:1004; +MainRule "str:|" "msg:mysql keyword (|)" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:8" id:1005; +MainRule "str:&&" "msg:mysql keyword (&&)" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:8" id:1006; +## end of hardcore rules +MainRule "str:--" "msg:mysql comment (--)" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:4" id:1007; +MainRule "str:;" "msg:semicolon" "mz:BODY|URL|ARGS" "s:$SQL:4,$XSS:8" id:1008; +MainRule "str:=" "msg:equal sign in var, probable sql/xss" "mz:ARGS|BODY" "s:$SQL:2" id:1009; +MainRule "str:(" "msg:open parenthesis, probable sql/xss" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$SQL:4,$XSS:8" id:1010; +MainRule "str:)" "msg:close parenthesis, probable sql/xss" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$SQL:4,$XSS:8" id:1011; +MainRule "str:'" "msg:simple quote" "mz:ARGS|BODY|URL|$HEADERS_VAR:Cookie" "s:$SQL:4,$XSS:8" id:1013; +MainRule "str:," "msg:comma" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:4" id:1015; +MainRule "str:#" "msg:mysql comment (#)" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:4" id:1016; +MainRule "str:@@" "msg:double arobase (@@)" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:4" id:1017; +MainRule "rx:::json|to_json|jsonb?_build|jsonb?_object|jsonb?_each|jsonb?_extract|jsonb?_typeof|jsonb?_array|jsonb_set|json_query|json_keys" "msg:json functions and operators" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$SQL:8" id:1018; + +############################### +## OBVIOUS RFI IDs:1100-1199 ## +############################### +MainRule "str:http://" "msg:http:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1100; +MainRule "str:https://" "msg:https:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1101; +MainRule "str:ftp://" "msg:ftp:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1102; +MainRule "str:php://" "msg:php:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1103; +MainRule "str:sftp://" "msg:sftp:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1104; +MainRule "str:zlib://" "msg:zlib:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1105; +MainRule "str:data://" "msg:data:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1106; +MainRule "str:glob://" "msg:glob:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1107; +MainRule "str:phar://" "msg:phar:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1108; +MainRule "str:file://" "msg:file:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1109; +MainRule "str:gopher://" "msg:gopher:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1110; +MainRule "str:zip://" "msg:zip:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1111; +MainRule "str:expect://" "msg:expect:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1112; +MainRule "str:input://" "msg:input:// scheme" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$RFI:8" id:1113; + +####################################### +## Directory traversal IDs:1200-1299 ## +####################################### +MainRule "str:.." "msg:double dot" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1200; +MainRule "str:/etc/passwd" "msg:obvious probe" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1202; +MainRule "str:c:\\" "msg:obvious windows path" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1203; +MainRule "str:cmd.exe" "msg:obvious probe" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1204; +MainRule "str:\\" "msg:backslash" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1205; +#MainRule "str:/" "msg:slash in args" "mz:ARGS|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:2" id:1206; +MainRule "str:/..;/" "msg:dir traversal bypass" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:2" id:1207; +MainRule "str:/.;/" "msg:dir traversal bypass" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1208; +MainRule "str:/.%2e/" "msg:dir traversal bypass" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1209; +MainRule "str:/%2e./" "msg:dir traversal bypass" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$TRAVERSAL:4" id:1210; + +######################################## +## Cross Site Scripting IDs:1300-1399 ## +######################################## +MainRule "str:<" "msg:html open tag" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$XSS:8" id:1302; +MainRule "str:>" "msg:html close tag" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$XSS:8" id:1303; +MainRule "str:[" "msg:open square backet ([), possible js" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$XSS:4" id:1310; +MainRule "str:]" "msg:close square bracket (]), possible js" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$XSS:4" id:1311; +MainRule "str:~" "msg:tilde (~) character" "mz:BODY|URL|ARGS|$HEADERS_VAR:Cookie" "s:$XSS:4" id:1312; +MainRule "str:`" "msg:grave accent (`)" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$XSS:8" id:1314; +MainRule "rx:%[23]." "msg:double encoding" "mz:ARGS|URL|BODY|$HEADERS_VAR:Cookie" "s:$XSS:8" id:1315; + +#################################### +## Evading tricks IDs: 1400-1500 ## +#################################### +MainRule "str:&#" "msg:utf7/8 encoding" "mz:ARGS|BODY|URL|$HEADERS_VAR:Cookie" "s:$EVADE:4" id:1400; +MainRule "str:%U" "msg:M$ encoding" "mz:ARGS|BODY|URL|$HEADERS_VAR:Cookie" "s:$EVADE:4" id:1401; + +############################# +## File uploads: 1500-1600 ## +############################# +MainRule "rx:\.ph|\.asp|\.ht|\.jsp" "msg:asp/php/jsp/htaccess file upload" "mz:FILE_EXT" "s:$UPLOAD:8" id:1500; +MainRule "rx:^[\.a-z0-9_\- ]+$" negative "msg:uploaded filename contains non-printable ascii chars" "mz:FILE_EXT" "s:$UPLOAD:8" id:1501; \ No newline at end of file diff --git a/containers/conf/angie/naxsi_rules/whitelists/dokuwiki.rules b/containers/conf/angie/naxsi_rules/whitelists/dokuwiki.rules new file mode 100644 index 00000000..21f5ba36 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/dokuwiki.rules @@ -0,0 +1,7 @@ +# DokuWiki rules + +BasicRule wl:1015 "mz:$BODY_VAR:usergroups"; +BasicRule wl:0 "mz:$BODY_VAR:wikitext"; +BasicRule wl:0 "mz:$BODY_VAR:summary"; +BasicRule wl:0 "mz:$BODY_VAR:prefix"; +BasicRule wl:0 "mz:$BODY_VAR:suffix"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/drupal.rules b/containers/conf/angie/naxsi_rules/whitelists/drupal.rules new file mode 100644 index 00000000..b96a4cfb --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/drupal.rules @@ -0,0 +1,61 @@ +#################################### +## Drupal whitelists ALPHA ## +#################################### + +# some url patterns +BasicRule wl:1000 "mz:$URL:/modules/update/update.css|URL"; +BasicRule wl:1000 "mz:$URL:/misc/tableselect.js|URL"; +BasicRule wl:1000 "mz:$URL:/modules/contextual/images/gear-select.png|URL|$HEADERS_VAR:cookie"; +BasicRule wl:1000 "mz:$URL:/misc/ui/jquery.ui.sortable.min.js|URL|$HEADERS_VAR:cookie"; +BasicRule wl:1000 "mz:$URL:/misc/tableheader.js|URL|$HEADERS_VAR:cookie"; +BasicRule wl:1000 "mz:$URL:/misc/tabledrag.js|URL|$HEADERS_VAR:cookie"; + +# bad keywords in posts etc (update etc) +BasicRule wl:1000 "mz:$URL:/|$BODY_VAR:comment_confirm_delete|NAME"; +BasicRule wl:1000 "mz:$URL:/|$ARGS_VAR:q"; +BasicRule wl:1000 "mz:$URL:/|$BODY_VAR:form_id"; +BasicRule wl:1000 "mz:$URL:/|$HEADERS_VAR:cookie"; +BasicRule wl:1010 "mz:$URL:/|$ARGS_VAR:date"; + +# XSS because of [ and ] in POST variables +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^body|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^menu|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^path|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^comment_body|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^field_|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^type|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^modules|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^blocks|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^palette|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^regions|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^roles|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^fields|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$ARGS_VAR_X:^destination|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^filter|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^search_active_modules|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^shortcuts|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^formats|NAME"; + +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:status"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:role"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:permission"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:type"; + +# update module +BasicRule wl:16 "mz:$URL:/|BODY"; + +# user mail +BasicRule wl:1007,1010,1011,1013,1015,1310,1311 "mz:$URL:/|$BODY_VAR_X:^user_mail"; + +# other stuff +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:form_build_id"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:menu[parent]"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:form_token"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:additional_settings__active_tab"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:date"; + +BasicRule wl:1302,1303 "mz:$URL:/|$BODY_VAR_X:^filters"; +BasicRule wl:1010,1011 "mz:$URL:/|$BODY_VAR:actions_label"; +BasicRule wl:1015 "mz:$URL:/|$BODY_VAR:date_format_long"; +BasicRule wl:1009,1016 "mz:$URL:/|$ARGS_VAR:destination"; +BasicRule wl:1016 "mz:$URL:/|$BODY_VAR_X:^palette"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/etherpad-lite.rules b/containers/conf/angie/naxsi_rules/whitelists/etherpad-lite.rules new file mode 100644 index 00000000..281d973c --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/etherpad-lite.rules @@ -0,0 +1,7 @@ +# Etherpad: Really real-time collaborative document editing http://etherpad.org +BasicRule wl:1001,1008,1010,1011,1013,1015,1101 "mz:$URL:/jserror|$BODY_VAR:errorinfo"; +BasicRule wl:2 "mz:$URL_X:^/p/.*/import$|BODY"; +BasicRule wl:1311 "mz:$URL_X:^/p/.*]$|URL"; +BasicRule wl:1007 "mz:URL"; +BasicRule wl:1315 "mz:$HEADERS_VAR:cookie"; +BasicRule wl:11 "mz:$URL:/socket.io/|BODY"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/iris.rules b/containers/conf/angie/naxsi_rules/whitelists/iris.rules new file mode 100644 index 00000000..63938c00 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/iris.rules @@ -0,0 +1,10 @@ +# Web IRC client Iris for the atheme platform https://github.com/atheme-legacy/iris +### Allowed chars in the URI of WebChat Wizard "custom link" or "embed" +BasicRule wl:1000,1315 "mz:$HEADERS_VAR:cookie"; +BasicRule wl:1015 "mz:$ARGS_VAR:channels"; +BasicRule wl:1000,1002,1005,1007,1013,1200,1205,1310,1311,1314 "mz:$ARGS_VAR:nick"; +BasicRule wl:1000,1005,1008,1013,1015,1200,1205 "mz:$URL:/|ARGS"; +### Allowed chars in Chat and Private +BasicRule wl:0 "mz:$URL:/e/p|$BODY_VAR:c"; +### Allowed chars in nick same as are allowed in IRCD +BasicRule wl:1000,1002,1005,1007,1205,1310,1311,1314 "mz:$URL:/e/n|$BODY_VAR:nick"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/rutorrent.rules b/containers/conf/angie/naxsi_rules/whitelists/rutorrent.rules new file mode 100644 index 00000000..6fcee642 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/rutorrent.rules @@ -0,0 +1,10 @@ +BasicRule wl:1005,1010,1011,1315 "mz:$HEADERS_VAR:cookie"; +BasicRule wl:1402 "mz:$HEADERS_VAR:content-type"; +BasicRule wl:11 "mz:$URL:/rutorrent/php/setsettings.php|BODY"; +BasicRule wl:11 "mz:$URL:/rutorrent/php/getsettings.php|BODY"; +BasicRule wl:1000,1001,1015,1310,1311 "mz:$BODY_VAR:v"; +BasicRule wl:1005,1008 "mz:$BODY_VAR:cookie"; +BasicRule wl:1000,1100,1101,1315 "mz:$BODY_VAR:url"; +BasicRule wl:1310,1311 "mz:$URL:/rutorrent/php/addtorrent.php|$ARGS_VAR:result[]|NAME"; +BasicRule wl:1000,1100,1101 "mz:$ARGS_VAR:name[]"; +BasicRule wl:1310,1311 "mz:$URL:/rutorrent/php/addtorrent.php|$ARGS_VAR:name[]|NAME"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/dokuwiki.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/dokuwiki.rules new file mode 100644 index 00000000..21f5ba36 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/dokuwiki.rules @@ -0,0 +1,7 @@ +# DokuWiki rules + +BasicRule wl:1015 "mz:$BODY_VAR:usergroups"; +BasicRule wl:0 "mz:$BODY_VAR:wikitext"; +BasicRule wl:0 "mz:$BODY_VAR:summary"; +BasicRule wl:0 "mz:$BODY_VAR:prefix"; +BasicRule wl:0 "mz:$BODY_VAR:suffix"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/drupal.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/drupal.rules new file mode 100644 index 00000000..b96a4cfb --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/drupal.rules @@ -0,0 +1,61 @@ +#################################### +## Drupal whitelists ALPHA ## +#################################### + +# some url patterns +BasicRule wl:1000 "mz:$URL:/modules/update/update.css|URL"; +BasicRule wl:1000 "mz:$URL:/misc/tableselect.js|URL"; +BasicRule wl:1000 "mz:$URL:/modules/contextual/images/gear-select.png|URL|$HEADERS_VAR:cookie"; +BasicRule wl:1000 "mz:$URL:/misc/ui/jquery.ui.sortable.min.js|URL|$HEADERS_VAR:cookie"; +BasicRule wl:1000 "mz:$URL:/misc/tableheader.js|URL|$HEADERS_VAR:cookie"; +BasicRule wl:1000 "mz:$URL:/misc/tabledrag.js|URL|$HEADERS_VAR:cookie"; + +# bad keywords in posts etc (update etc) +BasicRule wl:1000 "mz:$URL:/|$BODY_VAR:comment_confirm_delete|NAME"; +BasicRule wl:1000 "mz:$URL:/|$ARGS_VAR:q"; +BasicRule wl:1000 "mz:$URL:/|$BODY_VAR:form_id"; +BasicRule wl:1000 "mz:$URL:/|$HEADERS_VAR:cookie"; +BasicRule wl:1010 "mz:$URL:/|$ARGS_VAR:date"; + +# XSS because of [ and ] in POST variables +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^body|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^menu|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^path|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^comment_body|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^field_|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^type|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^modules|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^blocks|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^palette|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^regions|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^roles|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^fields|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$ARGS_VAR_X:^destination|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^filter|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^search_active_modules|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^shortcuts|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR_X:^formats|NAME"; + +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:status"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:role"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:permission"; +BasicRule wl:1310,1311 "mz:$URL:/|$BODY_VAR:type"; + +# update module +BasicRule wl:16 "mz:$URL:/|BODY"; + +# user mail +BasicRule wl:1007,1010,1011,1013,1015,1310,1311 "mz:$URL:/|$BODY_VAR_X:^user_mail"; + +# other stuff +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:form_build_id"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:menu[parent]"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:form_token"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:additional_settings__active_tab"; +BasicRule wl:1007 "mz:$URL:/|$BODY_VAR:date"; + +BasicRule wl:1302,1303 "mz:$URL:/|$BODY_VAR_X:^filters"; +BasicRule wl:1010,1011 "mz:$URL:/|$BODY_VAR:actions_label"; +BasicRule wl:1015 "mz:$URL:/|$BODY_VAR:date_format_long"; +BasicRule wl:1009,1016 "mz:$URL:/|$ARGS_VAR:destination"; +BasicRule wl:1016 "mz:$URL:/|$BODY_VAR_X:^palette"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/etherpad-lite.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/etherpad-lite.rules new file mode 100644 index 00000000..281d973c --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/etherpad-lite.rules @@ -0,0 +1,7 @@ +# Etherpad: Really real-time collaborative document editing http://etherpad.org +BasicRule wl:1001,1008,1010,1011,1013,1015,1101 "mz:$URL:/jserror|$BODY_VAR:errorinfo"; +BasicRule wl:2 "mz:$URL_X:^/p/.*/import$|BODY"; +BasicRule wl:1311 "mz:$URL_X:^/p/.*]$|URL"; +BasicRule wl:1007 "mz:URL"; +BasicRule wl:1315 "mz:$HEADERS_VAR:cookie"; +BasicRule wl:11 "mz:$URL:/socket.io/|BODY"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/generic.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/generic.rules new file mode 100644 index 00000000..26d84508 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/generic.rules @@ -0,0 +1,5 @@ +# whitelist robots.txt +BasicRule wl:20000003 "mz:$URL:/robots.txt|URL"; + +# whitelist /.well-known/security.txt +BasicRule wl:20000003,20000045 "mz:$URL:/.well-known/security.txt|URL"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/iris.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/iris.rules new file mode 100644 index 00000000..63938c00 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/iris.rules @@ -0,0 +1,10 @@ +# Web IRC client Iris for the atheme platform https://github.com/atheme-legacy/iris +### Allowed chars in the URI of WebChat Wizard "custom link" or "embed" +BasicRule wl:1000,1315 "mz:$HEADERS_VAR:cookie"; +BasicRule wl:1015 "mz:$ARGS_VAR:channels"; +BasicRule wl:1000,1002,1005,1007,1013,1200,1205,1310,1311,1314 "mz:$ARGS_VAR:nick"; +BasicRule wl:1000,1005,1008,1013,1015,1200,1205 "mz:$URL:/|ARGS"; +### Allowed chars in Chat and Private +BasicRule wl:0 "mz:$URL:/e/p|$BODY_VAR:c"; +### Allowed chars in nick same as are allowed in IRCD +BasicRule wl:1000,1002,1005,1007,1205,1310,1311,1314 "mz:$URL:/e/n|$BODY_VAR:nick"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/jellyfin.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/jellyfin.rules new file mode 100644 index 00000000..f5c31bdf --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/jellyfin.rules @@ -0,0 +1,124 @@ +# Jellyfin rules + +# global +BasicRule wl:2,11 "mz:BODY"; +BasicRule wl:17 "mz:$HEADERS_VAR:accept"; +BasicRule wl:1000 "mz:URL"; +BasicRule wl:1000,1002 "mz:$HEADERS_VAR:cookie"; + +# /Users.* +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^Fields$|$URL_X:^/Users.*$"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^EnableImageTypes$|$URL_X:^/Users.*$"; +BasicRule wl:1000 "mz:$BODY_VAR_X:^RememberAudioSelections$|NAME|$URL_X:^/Users/[0-9a-f-]*.*$"; +BasicRule wl:1000 "mz:$BODY_VAR_X:^RememberSubtitleSelections$|NAME|$URL_X:^/Users/[0-9a-f-]*.*$"; +BasicRule wl:1015 "mz:$ARGS_VAR_X:^SortBy$|$URL_X:^/Users.*$"; +BasicRule wl:1015 "mz:$ARGS_VAR_X:^Ids$|$URL_X:^/Users.*$"; +BasicRule wl:1015 "mz:$ARGS_VAR_X:^MediaTypes$|$URL_X:^/Users.*$"; +BasicRule wl:1015 "mz:$ARGS_VAR_X:^SortOrder$|$URL_X:^/Users/[0-9a-f-]*/Items$"; +BasicRule wl:1015 "mz:$ARGS_VAR_X:^IncludeItemTypes$|$URL_X:^/Users/[0-9a-f-]*/Items$"; + +# /Users/authenticatebyname +BasicRule wl:1010,1011,1012,1302 "mz:$BODY_VAR:Pw|$URL:/Users/authenticatebyname"; + +# /UserItems/Resume +BasicRule wl:1015 "mz:$ARGS_VAR:fields|$URL:/UserItems/Resume"; + +# /Shows.* +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^Fields$|$URL_X:^/Shows/[0-9a-f-]*/Seasons$"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^Fields$|$URL_X:^/Shows/[0-9a-f-]*/Episodes$"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^EnableImageTypes$|$URL_X:^/Shows/NextUp.*$"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^Fields$|$URL_X:^/Shows/NextUp.*$"; +BasicRule wl:1000 "mz:$ARGS_VAR_X:^NextUpDateCutoff$|$URL_X:^/Shows/NextUp.*$"; +BasicRule wl:1015 "mz:$ARGS_VAR:StartIndex|$URL:/Shows/NextUp?"; + +# /DisplayPreferences +BasicRule wl:15,1000,1001,1015,1101,1205 "mz:BODY|$URL:/DisplayPreferences/usersettings"; +BasicRule wl:1000 "mz:$BODY_VAR_X:^chromecastVersion$|$URL_X:^/DisplayPreferences/[0-9a-f-]*$"; +BasicRule wl:1000 "mz:$BODY_VAR_X:^ShowBackdrop$|NAME|$URL_X:^/DisplayPreferences/[0-9a-f-]*$"; +BasicRule wl:1101 "mz:BODY|NAME|$URL:/DisplayPreferences/usersettings"; + +# /Items.* +BasicRule wl:17 "mz:$HEADERS_VAR_X:^accept$|$URL_X:^/Items/[0-9a-f-]*/.*$"; +BasicRule wl:1000 "mz:URL|$URL_X:^/Items/[0-9a-f-]*/.*$"; +BasicRule wl:1000 "mz:$ARGS_VAR_X:^inheritFromParent$|NAME|$URL_X:^/Items/[0-9a-f-]*/ThemeMedia$"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^Fields$|$URL_X:^/Items.*$"; +BasicRule wl:1005 "mz:$BODY_VAR_X:^Value$|$URL_X:^/Items/[0-9a-f-]*/PlaybackInfo$"; +BasicRule wl:1013,1100 "mz:$ARGS_VAR:searchTerm|$URL:/Items"; +BasicRule wl:1015 "mz:$BODY_VAR_X:^VideoCodec$|$URL_X:^/Items/[0-9a-f-]*/PlaybackInfo$"; +BasicRule wl:1015 "mz:$BODY_VAR_X:^AudioCodec$|$URL_X:^/Items/[0-9a-f-]*/PlaybackInfo$"; +BasicRule wl:1015 "mz:$BODY_VAR_X:^Container$|$URL_X:^/Items/[0-9a-f-]*/PlaybackInfo$"; +BasicRule wl:1015 "mz:$ARGS_VAR:ExcludeLocationTypes|$URL:/Items?"; +BasicRule wl:1015 "mz:$ARGS_VAR:Fields|$URL:/Items?"; +BasicRule wl:1015 "mz:$ARGS_VAR:Filters|$URL:/Items?"; +BasicRule wl:1015 "mz:$ARGS_VAR:ImageTypes|$URL:/Items?"; +BasicRule wl:1015 "mz:$ARGS_VAR:IncludeItemTypes|$URL:/Items?"; +BasicRule wl:1015 "mz:$ARGS_VAR:Recursive|$URL:/Items?"; +BasicRule wl:1015 "mz:$ARGS_VAR:SortBy|$URL:/Items?"; +BasicRule wl:1015 "mz:$ARGS_VAR:SortOrder|$URL:/Items?"; + +# /Shows/Upcoming +BasicRule wl:1000,1015 "mz:$ARGS_VAR:EnableImageTypes|$URL:/Shows/Upcoming"; + +# /Movies/Recommendations +BasicRule wl:1000,1015 "mz:$ARGS_VAR:Fields|$URL:/Movies/Recommendations"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR:EnableImageTypes|$URL:/Movies/Recommendations"; + +# /System/Configuration +BasicRule wl:1013,1015 "mz:$BODY_VAR:SortRemoveCharacters|$URL:/System/Configuration"; +BasicRule wl:1000 "mz:$BODY_VAR:LibraryUpdateDuration|$URL:/System/Configuration"; +BasicRule wl:1000 "mz:$BODY_VAR:Name|$URL:/System/Configuration"; +BasicRule wl:1101 "mz:$BODY_VAR:Url|$URL:/System/Configuration"; +BasicRule wl:50000006 "mz:$BODY_VAR:LibraryMonitorDelay|$URL:/System/Configuration"; +BasicRule wl:50000006 "mz:$BODY_VAR:ThrottleDelaySeconds|NAME|$URL:/System/Configuration/encoding"; + +# /System/Configuration/branding +BasicRule wl:1000,1001,1002,1003,1004,1008,1009,1010,1011,1015,1016,1205 "mz:$BODY_VAR:CustomCss|$URL:/System/Configuration/branding"; +BasicRule wl:1302 "mz:$BODY_VAR:LoginDisclaimer|$URL:/System/Configuration/branding"; + +# /Sessions +BasicRule wl:1000 "mz:$BODY_VAR:EventName|$URL:/Sessions/Playing/Progress"; +BasicRule wl:1000 "mz:$BODY_VAR:SupportedCommands|$URL:/Sessions/Capabilities"; +BasicRule wl:1000 "mz:$BODY_VAR:SupportedCommands|$URL:/Sessions/Capabilities/Full"; +BasicRule wl:1015 "mz:$BODY_VAR:AudioCodec|$URL:/Sessions/Capabilities/Full"; +BasicRule wl:1015 "mz:$BODY_VAR:VideoCodec|$URL:/Sessions/Capabilities/Full"; +BasicRule wl:1200 "mz:$HEADERS_VAR:cookie|$URL:/Sessions/Logout"; + +# Branding +BasicRule wl:1015 "mz:$BODY_VAR:Splashscreen|$URL:/Branding/Splashscreen"; + +# /Library +BasicRule wl:1005,1008,1205 "mz:$BODY_VAR:CustomTagDelimiters|$URL:/Library/VirtualFolders/LibraryOptions"; + +# /Playlists +BasicRule wl:1000,1015 "mz:$ARGS_VAR_X:^EnableImageTypes$|$URL_X:^/Playlists/[0-9a-f-]*/Items$"; +BasicRule wl:1015 "mz:$ARGS_VAR_X:^Fields$|$URL_X:^/Playlists/[0-9a-f-]*/Items$"; + +# /SyncPlay +BasicRule wl:1013 "mz:$BODY_VAR:GroupName|$URL:/SyncPlay/New"; + +# /Videos.* +BasicRule wl:12 "mz:ARGS|$URL_X:^/videos/.*$"; +BasicRule wl:17 "mz:$HEADERS_VAR_X:^accept$|$URL_X:^/Videos/.*$"; +BasicRule wl:1015 "mz:ARGS|$URL_X:^/videos/.*$"; + +# /LiveTv +BasicRule wl:1000,1015 "mz:$ARGS_VAR:EnableImageTypes|$URL:/LiveTv/Programs/Recommended"; +BasicRule wl:1015 "mz:$ARGS_VAR:Fields|$URL:/LiveTv/Programs"; +BasicRule wl:1015 "mz:$ARGS_VAR:Fields|$URL:/LiveTv/Programs/Recommended"; + +# Playback Reporting Plugin + +# /user_usage_stats +BasicRule wl:1015 "mz:$ARGS_VAR:filter|$URL:/user_usage_stats/PlayActivity"; +BasicRule wl:1015 "mz:$ARGS_VAR:filter|$URL:/user_usage_stats/HourlyReport"; +BasicRule wl:1015 "mz:$ARGS_VAR:filter|$URL:/user_usage_stats/DurationHistogramReport"; + +# Artist +BasicRule wl:1000,1015 "mz:$ARGS_VAR:fields|$URL:/Artists"; +BasicRule wl:1013,1100 "mz:$ARGS_VAR:searchTerm|$URL:/Artists"; +BasicRule wl:1015 "mz:$ARGS_VAR:SortBy|$URL:/Artists"; + +# Persons +BasicRule wl:1000,1013 "mz:$ARGS_VAR:fields|$URL:/Persons"; +BasicRule wl:1015 "mz:$ARGS_VAR:SortBy|$URL:/Persons"; +BasicRule wl:1100 "mz:$ARGS_VAR:searchTerm|$URL:/Persons"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/rutorrent.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/rutorrent.rules new file mode 100644 index 00000000..6fcee642 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/rutorrent.rules @@ -0,0 +1,10 @@ +BasicRule wl:1005,1010,1011,1315 "mz:$HEADERS_VAR:cookie"; +BasicRule wl:1402 "mz:$HEADERS_VAR:content-type"; +BasicRule wl:11 "mz:$URL:/rutorrent/php/setsettings.php|BODY"; +BasicRule wl:11 "mz:$URL:/rutorrent/php/getsettings.php|BODY"; +BasicRule wl:1000,1001,1015,1310,1311 "mz:$BODY_VAR:v"; +BasicRule wl:1005,1008 "mz:$BODY_VAR:cookie"; +BasicRule wl:1000,1100,1101,1315 "mz:$BODY_VAR:url"; +BasicRule wl:1310,1311 "mz:$URL:/rutorrent/php/addtorrent.php|$ARGS_VAR:result[]|NAME"; +BasicRule wl:1000,1100,1101 "mz:$ARGS_VAR:name[]"; +BasicRule wl:1310,1311 "mz:$URL:/rutorrent/php/addtorrent.php|$ARGS_VAR:name[]|NAME"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/wordpress-minimal.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/wordpress-minimal.rules new file mode 100644 index 00000000..84c7f0be --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/wordpress-minimal.rules @@ -0,0 +1,26 @@ +######### ######### +###### ###### +### Because of wordpress.rules is full of wl rules even got double. ### +### Thats why I start from scratch so these rules are in BETA us on own risk. ### +### I us not that many plugins and those I use only after I checked there code. ### +###### ###### +######### ######### +### HEADERS +BasicRule wl:1001,1315 "mz:$HEADERS_VAR:cookie"; +### Theme customize +BasicRule wl:1001,1015,1310,1311 "mz:$URL_X:^/.*$|$BODY_VAR_X:^customized$|BODY"; +### Widget customize +BasicRule wl:1001,1015,1310,1311 "mz:$URL_X:^/.*$|$BODY_VAR_X:^partials$|BODY"; +### oEmbed API +BasicRule wl:1000,1009,1101 "mz:$URL_X:^/.*wp-json/oembed/1.0/embed|$ARGS_VAR_X:^url$"; +BasicRule wl:1009,1101 "mz:$URL_X:^/.*wp-json/oembed/1.0/embed|ARGS"; +BasicRule wl:1009,1101 "mz:ARGS"; +### Trackbacks +BasicRule wl:1005,1008,1010,1011,1015,1016,1100,1101,1400 "mz:$URL_X:^/.*trackback$/|BODY"; +BasicRule wl:1005,1008,1010,1011,1015,1016,1100,1101,1400 "mz:BODY"; +BasicRule wl:1008,1010,1011,1015,1016,1100,1101,1400 "mz:$URL_X:^/.*trackback$/|$BODY_VAR_X:^excerpt$"; +BasicRule wl:1008,1010,1011,1015,1016,1100,1101,1400 "mz:$BODY_VAR:excerpt"; +BasicRule wl:1101 "mz:$URL_X:^/.*trackback$/|$BODY_VAR_X:^url$"; +BasicRule wl:1005 "mz:$URL_X:^/.*trackback$/|$BODY_VAR_X:^title$"; +BasicRule wl:1101 "mz:$BODY_VAR:url"; +BasicRule wl:1005 "mz:$BODY_VAR:title"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/wordpress.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/wordpress.rules new file mode 100644 index 00000000..23d58ad3 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/wordpress.rules @@ -0,0 +1,152 @@ +# WordPress naxsi rules + +### HEADERS +BasicRule wl:1000,1001,1005,1007,1010,1011,1013,1100,1101,1200,1308,1309,1310,1311,1315 "mz:$HEADERS_VAR:cookie"; +# xmlrpc +BasicRule wl:1402 "mz:$HEADERS_VAR:content-type"; + +### simple BODY (POST) +BasicRule wl:1001,1009,1015,1016,1101,1310,1311 "mz:$URL:/|$BODY_VAR:customized"; +# comments +BasicRule wl:1000,1010,1011,1013,1015,1200,1310,1311 "mz:$BODY_VAR:post_title"; +BasicRule wl:1000 "mz:$BODY_VAR:original_publish"; +BasicRule wl:1000 "mz:$BODY_VAR:save"; +BasicRule wl:1008,1010,1011,1013,1015 "mz:$BODY_VAR:sk2_my_js_payload"; +BasicRule wl:1001,1005,1009,1016,1100,1101,1310 "mz:$BODY_VAR:url"; +BasicRule wl:1009,1100,1101 "mz:$BODY_VAR:referredby"; +BasicRule wl:1009,1100,1101 "mz:$BODY_VAR:_wp_original_http_referer"; +BasicRule wl:1000,1001,1005,1007,1008,1009,1010,1011,1013,1015,1016,1100,1101,1200,1302,1303,1310,1311,1315,1400 "mz:$BODY_VAR:comment"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:redirect_to"; +BasicRule wl:1000,1009,1315 "mz:$BODY_VAR:_wp_http_referer"; +BasicRule wl:1000 "mz:$BODY_VAR:action"; +BasicRule wl:1001,1013 "mz:$BODY_VAR:blogname"; +BasicRule wl:1013,1015 "mz:$BODY_VAR:blogdescription"; +BasicRule wl:1015 "mz:$BODY_VAR:date_format_custom"; +BasicRule wl:1015 "mz:$BODY_VAR:date_format"; +BasicRule wl:1015 "mz:$BODY_VAR:tax_input%5bpost_tag%5d"; +BasicRule wl:1015 "mz:$BODY_VAR:tax_input[post_tag]"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:siteurl"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:home"; +BasicRule wl:1000,1015 "mz:$BODY_VAR:submit"; +# news content matches pretty much everything +BasicRule wl:0 "mz:$BODY_VAR:content"; +BasicRule wl:1000 "mz:$BODY_VAR:delete_option"; +BasicRule wl:1000 "mz:$BODY_VAR:prowl-msg-message"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:_url"; +BasicRule wl:1001,1009 "mz:$BODY_VAR:c2c_text_replace%5btext_to_replace%5d"; +BasicRule wl:1200 "mz:$BODY_VAR:ppn_post_note"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:author"; +BasicRule wl:1001,1015 "mz:$BODY_VAR:excerpt"; +BasicRule wl:1015 "mz:$BODY_VAR:catslist"; +BasicRule wl:1005,1008,1009,1010,1011,1015,1315 "mz:$BODY_VAR:cookie"; +BasicRule wl:1101 "mz:$BODY_VAR:googleplus"; +BasicRule wl:1007 "mz:$BODY_VAR:name"; +BasicRule wl:1007 "mz:$BODY_VAR:action"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:attachment%5burl%5d"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:attachment_url"; +BasicRule wl:1001,1009,1100,1101,1302,1303,1310,1311 "mz:$BODY_VAR:html"; +BasicRule wl:1015 "mz:$BODY_VAR:title"; +BasicRule wl:1001,1009,1015 "mz:$BODY_VAR:recaptcha_challenge_field"; +BasicRule wl:1011 "mz:$BODY_VAR:pwd"; +BasicRule wl:1000 "mz:$BODY_VAR:excerpt"; + +### BODY|NAME +BasicRule wl:1000 "mz:$BODY_VAR:delete_option|NAME"; +BasicRule wl:1000 "mz:$BODY_VAR:from|NAME"; + +### Simple ARGS (GET) +# WP login screen +BasicRule wl:1100,1101 "mz:$ARGS_VAR:redirect_to"; +BasicRule wl:1000,1009 "mz:$ARGS_VAR:_wp_http_referer"; +BasicRule wl:1000 "mz:$ARGS_VAR:wp_http_referer"; +BasicRule wl:1000 "mz:$ARGS_VAR:action"; +BasicRule wl:1000 "mz:$ARGS_VAR:action2"; +# load and load[] GET variable +BasicRule wl:1000,1015 "mz:$ARGS_VAR:load"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR:load[]"; +BasicRule wl:1015 "mz:$ARGS_VAR:q"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR:load%5b%5d"; + +### URL +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update-core.php"; +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update.php"; +BasicRule wl:1000 "mz:$URL:/wp-includes/js/imgareaselect/imgareaselect.css|URL"; +BasicRule wl:1002 "mz:$URL_X:/wp-content/uploads/[0-9]{4}/[0-9]{2}/[^/]+\.jpg$|URL"; +# URL|ARGS +BasicRule wl:1015 "mz:$URL:/wp-admin/load-styles.php|$ARGS_VAR:dashicons,admin-bar,wp-admin,buttons,wp-auth-check"; +BasicRule wl:1000 "mz:$URL:/wp-admin/about.php|$ARGS_VAR:updated"; +BasicRule wl:1009 "mz:$URL:/wp-admin/customize.php|$ARGS_VAR:return"; +# URL|BODY +BasicRule wl:1009,1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_http_referer"; +BasicRule wl:1016 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect"; +BasicRule wl:11 "mz:$URL:/xmlrpc.php|BODY"; +BasicRule wl:11,16 "mz:$URL:/wp-cron.php|BODY"; +BasicRule wl:2 "mz:$URL:/wp-admin/async-upload.php|BODY"; +# URL|BODY|NAME +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_original_http_referer|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/user-edit.php|$BODY_VAR:from|NAME"; +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:attachment%5burl%5d|NAME"; +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:attachment_url|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/plugins.php|$BODY_VAR:verify-delete|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:post_category[]|NAME"; +BasicRule wl:1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:post_category|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:tax_input[post_tag]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:newtag[post_tag]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/users.php|$BODY_VAR:users[]|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/update-core.php|$BODY_VAR:Update%2BTranslations|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/update-core.php|$BODY_VAR:Update%2BNow|NAME"; +# URL|ARGS|NAME +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/load-scripts.php|$ARGS_VAR:load[]|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:delete_count|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:update|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/customize.php|$ARGS_VAR:autofocus[control]|NAME"; + +# plain WP site +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update-core.php"; +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update.php"; +# URL|BODY +BasicRule wl:1009,1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_http_referer"; +BasicRule wl:1016 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect"; +BasicRule wl:11 "mz:$URL:/xmlrpc.php|BODY"; +BasicRule wl:11,16 "mz:$URL:/wp-cron.php|BODY"; +# URL|BODY|NAME +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_original_http_referer|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/user-edit.php|$BODY_VAR:from|NAME"; +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:attachment%5burl%5d|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-auth-check]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-check-locked-posts][]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-refresh-post-lock][post_id]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-refresh-post-lock][lock]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/update-core.php|$BODY_VAR:checked[]|NAME"; +# URL|ARGS|NAME +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/load-scripts.php|$ARGS_VAR:load[]|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:delete_count|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:update|NAME"; + +### Plugins +#WP Minify +BasicRule wl:1015 "mz:$URL:/wp-content/plugins/bwp-minify/min/|$ARGS_VAR:f"; +#Jetpack Infinite Scroll +BasicRule wl:1310,1311 "mz:$BODY_VAR:scripts[]|NAME"; +BasicRule wl:1310,1311 "mz:$BODY_VAR:styles[]|NAME"; +BasicRule wl:1310,1311 "mz:$BODY_VAR_X:^query_args\[.*\]|NAME"; +BasicRule wl:1000 "mz:$BODY_VAR:query_args[update_post_term_cache]|NAME"; +BasicRule wl:1000 "mz:$BODY_VAR:query_args[update_post_meta_cache]|NAME"; +#UpdraftPlus +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/updraftplus/includes/select2/select2.min.css|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/updraftplus/includes/select2/select2.min.js|URL"; +#WP plugin updates +BasicRule wl:1315 "mz:$ARGS_VAR:query|$URL:/wp-json/jetpack/v4/jitm"; +#Jetpack Google Fonts +BasicRule wl:1001 "mz:$URL_X:^/wp-content/plugins/jetpack/css/.*|URL"; +#WooCommerce +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/woocommerce/assets/js/select2/select2.full.min.js|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/woocommerce/assets/js/selectWoo/selectWoo.full.min.js|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/woocommerce/assets/js/stupidtable/stupidtable.min.js|URL"; +#WPML +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/sitepress-multilingual-cms/lib/select2/select2.min.js|URL"; +#Yoast SEO +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/wordpress-seo/js/dist/select2/select2.full.min.js|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/wordpress-seo/css/dist/select2/select2.min.css|URL"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/whitelists/zerobin.rules b/containers/conf/angie/naxsi_rules/whitelists/whitelists/zerobin.rules new file mode 100644 index 00000000..4b7b4e4f --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/whitelists/zerobin.rules @@ -0,0 +1,8 @@ +# Zerobin is here in directory /paste if diffrent change $URL:/paste/ below +BasicRule wl:1015 "mz:$URL:/paste/|$BODY_VAR:data"; +BasicRule wl:1315 "mz:$URL:/paste/|$HEADERS_VAR:cookie"; +BasicRule wl:1001 "mz:$URL:/paste/|$BODY_VAR:data"; +BasicRule wl:1009 "mz:$URL:/paste/|$BODY_VAR:data"; +BasicRule wl:1009 "mz:$URL:/paste/|$BODY_VAR:nickname"; +BasicRule wl:1001 "mz:$URL:/paste/|$BODY_VAR:nickname"; +BasicRule wl:1015 "mz:$URL:/paste/|$BODY_VAR:nickname"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/wordpress-minimal.rules b/containers/conf/angie/naxsi_rules/whitelists/wordpress-minimal.rules new file mode 100644 index 00000000..84c7f0be --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/wordpress-minimal.rules @@ -0,0 +1,26 @@ +######### ######### +###### ###### +### Because of wordpress.rules is full of wl rules even got double. ### +### Thats why I start from scratch so these rules are in BETA us on own risk. ### +### I us not that many plugins and those I use only after I checked there code. ### +###### ###### +######### ######### +### HEADERS +BasicRule wl:1001,1315 "mz:$HEADERS_VAR:cookie"; +### Theme customize +BasicRule wl:1001,1015,1310,1311 "mz:$URL_X:^/.*$|$BODY_VAR_X:^customized$|BODY"; +### Widget customize +BasicRule wl:1001,1015,1310,1311 "mz:$URL_X:^/.*$|$BODY_VAR_X:^partials$|BODY"; +### oEmbed API +BasicRule wl:1000,1009,1101 "mz:$URL_X:^/.*wp-json/oembed/1.0/embed|$ARGS_VAR_X:^url$"; +BasicRule wl:1009,1101 "mz:$URL_X:^/.*wp-json/oembed/1.0/embed|ARGS"; +BasicRule wl:1009,1101 "mz:ARGS"; +### Trackbacks +BasicRule wl:1005,1008,1010,1011,1015,1016,1100,1101,1400 "mz:$URL_X:^/.*trackback$/|BODY"; +BasicRule wl:1005,1008,1010,1011,1015,1016,1100,1101,1400 "mz:BODY"; +BasicRule wl:1008,1010,1011,1015,1016,1100,1101,1400 "mz:$URL_X:^/.*trackback$/|$BODY_VAR_X:^excerpt$"; +BasicRule wl:1008,1010,1011,1015,1016,1100,1101,1400 "mz:$BODY_VAR:excerpt"; +BasicRule wl:1101 "mz:$URL_X:^/.*trackback$/|$BODY_VAR_X:^url$"; +BasicRule wl:1005 "mz:$URL_X:^/.*trackback$/|$BODY_VAR_X:^title$"; +BasicRule wl:1101 "mz:$BODY_VAR:url"; +BasicRule wl:1005 "mz:$BODY_VAR:title"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/wordpress.rules b/containers/conf/angie/naxsi_rules/whitelists/wordpress.rules new file mode 100644 index 00000000..23d58ad3 --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/wordpress.rules @@ -0,0 +1,152 @@ +# WordPress naxsi rules + +### HEADERS +BasicRule wl:1000,1001,1005,1007,1010,1011,1013,1100,1101,1200,1308,1309,1310,1311,1315 "mz:$HEADERS_VAR:cookie"; +# xmlrpc +BasicRule wl:1402 "mz:$HEADERS_VAR:content-type"; + +### simple BODY (POST) +BasicRule wl:1001,1009,1015,1016,1101,1310,1311 "mz:$URL:/|$BODY_VAR:customized"; +# comments +BasicRule wl:1000,1010,1011,1013,1015,1200,1310,1311 "mz:$BODY_VAR:post_title"; +BasicRule wl:1000 "mz:$BODY_VAR:original_publish"; +BasicRule wl:1000 "mz:$BODY_VAR:save"; +BasicRule wl:1008,1010,1011,1013,1015 "mz:$BODY_VAR:sk2_my_js_payload"; +BasicRule wl:1001,1005,1009,1016,1100,1101,1310 "mz:$BODY_VAR:url"; +BasicRule wl:1009,1100,1101 "mz:$BODY_VAR:referredby"; +BasicRule wl:1009,1100,1101 "mz:$BODY_VAR:_wp_original_http_referer"; +BasicRule wl:1000,1001,1005,1007,1008,1009,1010,1011,1013,1015,1016,1100,1101,1200,1302,1303,1310,1311,1315,1400 "mz:$BODY_VAR:comment"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:redirect_to"; +BasicRule wl:1000,1009,1315 "mz:$BODY_VAR:_wp_http_referer"; +BasicRule wl:1000 "mz:$BODY_VAR:action"; +BasicRule wl:1001,1013 "mz:$BODY_VAR:blogname"; +BasicRule wl:1013,1015 "mz:$BODY_VAR:blogdescription"; +BasicRule wl:1015 "mz:$BODY_VAR:date_format_custom"; +BasicRule wl:1015 "mz:$BODY_VAR:date_format"; +BasicRule wl:1015 "mz:$BODY_VAR:tax_input%5bpost_tag%5d"; +BasicRule wl:1015 "mz:$BODY_VAR:tax_input[post_tag]"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:siteurl"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:home"; +BasicRule wl:1000,1015 "mz:$BODY_VAR:submit"; +# news content matches pretty much everything +BasicRule wl:0 "mz:$BODY_VAR:content"; +BasicRule wl:1000 "mz:$BODY_VAR:delete_option"; +BasicRule wl:1000 "mz:$BODY_VAR:prowl-msg-message"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:_url"; +BasicRule wl:1001,1009 "mz:$BODY_VAR:c2c_text_replace%5btext_to_replace%5d"; +BasicRule wl:1200 "mz:$BODY_VAR:ppn_post_note"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:author"; +BasicRule wl:1001,1015 "mz:$BODY_VAR:excerpt"; +BasicRule wl:1015 "mz:$BODY_VAR:catslist"; +BasicRule wl:1005,1008,1009,1010,1011,1015,1315 "mz:$BODY_VAR:cookie"; +BasicRule wl:1101 "mz:$BODY_VAR:googleplus"; +BasicRule wl:1007 "mz:$BODY_VAR:name"; +BasicRule wl:1007 "mz:$BODY_VAR:action"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:attachment%5burl%5d"; +BasicRule wl:1100,1101 "mz:$BODY_VAR:attachment_url"; +BasicRule wl:1001,1009,1100,1101,1302,1303,1310,1311 "mz:$BODY_VAR:html"; +BasicRule wl:1015 "mz:$BODY_VAR:title"; +BasicRule wl:1001,1009,1015 "mz:$BODY_VAR:recaptcha_challenge_field"; +BasicRule wl:1011 "mz:$BODY_VAR:pwd"; +BasicRule wl:1000 "mz:$BODY_VAR:excerpt"; + +### BODY|NAME +BasicRule wl:1000 "mz:$BODY_VAR:delete_option|NAME"; +BasicRule wl:1000 "mz:$BODY_VAR:from|NAME"; + +### Simple ARGS (GET) +# WP login screen +BasicRule wl:1100,1101 "mz:$ARGS_VAR:redirect_to"; +BasicRule wl:1000,1009 "mz:$ARGS_VAR:_wp_http_referer"; +BasicRule wl:1000 "mz:$ARGS_VAR:wp_http_referer"; +BasicRule wl:1000 "mz:$ARGS_VAR:action"; +BasicRule wl:1000 "mz:$ARGS_VAR:action2"; +# load and load[] GET variable +BasicRule wl:1000,1015 "mz:$ARGS_VAR:load"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR:load[]"; +BasicRule wl:1015 "mz:$ARGS_VAR:q"; +BasicRule wl:1000,1015 "mz:$ARGS_VAR:load%5b%5d"; + +### URL +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update-core.php"; +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update.php"; +BasicRule wl:1000 "mz:$URL:/wp-includes/js/imgareaselect/imgareaselect.css|URL"; +BasicRule wl:1002 "mz:$URL_X:/wp-content/uploads/[0-9]{4}/[0-9]{2}/[^/]+\.jpg$|URL"; +# URL|ARGS +BasicRule wl:1015 "mz:$URL:/wp-admin/load-styles.php|$ARGS_VAR:dashicons,admin-bar,wp-admin,buttons,wp-auth-check"; +BasicRule wl:1000 "mz:$URL:/wp-admin/about.php|$ARGS_VAR:updated"; +BasicRule wl:1009 "mz:$URL:/wp-admin/customize.php|$ARGS_VAR:return"; +# URL|BODY +BasicRule wl:1009,1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_http_referer"; +BasicRule wl:1016 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect"; +BasicRule wl:11 "mz:$URL:/xmlrpc.php|BODY"; +BasicRule wl:11,16 "mz:$URL:/wp-cron.php|BODY"; +BasicRule wl:2 "mz:$URL:/wp-admin/async-upload.php|BODY"; +# URL|BODY|NAME +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_original_http_referer|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/user-edit.php|$BODY_VAR:from|NAME"; +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:attachment%5burl%5d|NAME"; +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:attachment_url|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/plugins.php|$BODY_VAR:verify-delete|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:post_category[]|NAME"; +BasicRule wl:1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:post_category|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:tax_input[post_tag]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/post.php|$BODY_VAR:newtag[post_tag]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/users.php|$BODY_VAR:users[]|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/update-core.php|$BODY_VAR:Update%2BTranslations|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/update-core.php|$BODY_VAR:Update%2BNow|NAME"; +# URL|ARGS|NAME +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/load-scripts.php|$ARGS_VAR:load[]|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:delete_count|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:update|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/customize.php|$ARGS_VAR:autofocus[control]|NAME"; + +# plain WP site +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update-core.php"; +BasicRule wl:1000 "mz:URL|$URL:/wp-admin/update.php"; +# URL|BODY +BasicRule wl:1009,1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_http_referer"; +BasicRule wl:1016 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect"; +BasicRule wl:11 "mz:$URL:/xmlrpc.php|BODY"; +BasicRule wl:11,16 "mz:$URL:/wp-cron.php|BODY"; +# URL|BODY|NAME +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/post.php|$BODY_VAR:_wp_original_http_referer|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/post.php|$BODY_VAR:metakeyselect|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/user-edit.php|$BODY_VAR:from|NAME"; +BasicRule wl:1100,1101 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:attachment%5burl%5d|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-auth-check]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-check-locked-posts][]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-refresh-post-lock][post_id]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/admin-ajax.php|$BODY_VAR:data[wp-refresh-post-lock][lock]|NAME"; +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/update-core.php|$BODY_VAR:checked[]|NAME"; +# URL|ARGS|NAME +BasicRule wl:1310,1311 "mz:$URL:/wp-admin/load-scripts.php|$ARGS_VAR:load[]|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:delete_count|NAME"; +BasicRule wl:1000 "mz:$URL:/wp-admin/users.php|$ARGS_VAR:update|NAME"; + +### Plugins +#WP Minify +BasicRule wl:1015 "mz:$URL:/wp-content/plugins/bwp-minify/min/|$ARGS_VAR:f"; +#Jetpack Infinite Scroll +BasicRule wl:1310,1311 "mz:$BODY_VAR:scripts[]|NAME"; +BasicRule wl:1310,1311 "mz:$BODY_VAR:styles[]|NAME"; +BasicRule wl:1310,1311 "mz:$BODY_VAR_X:^query_args\[.*\]|NAME"; +BasicRule wl:1000 "mz:$BODY_VAR:query_args[update_post_term_cache]|NAME"; +BasicRule wl:1000 "mz:$BODY_VAR:query_args[update_post_meta_cache]|NAME"; +#UpdraftPlus +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/updraftplus/includes/select2/select2.min.css|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/updraftplus/includes/select2/select2.min.js|URL"; +#WP plugin updates +BasicRule wl:1315 "mz:$ARGS_VAR:query|$URL:/wp-json/jetpack/v4/jitm"; +#Jetpack Google Fonts +BasicRule wl:1001 "mz:$URL_X:^/wp-content/plugins/jetpack/css/.*|URL"; +#WooCommerce +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/woocommerce/assets/js/select2/select2.full.min.js|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/woocommerce/assets/js/selectWoo/selectWoo.full.min.js|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/woocommerce/assets/js/stupidtable/stupidtable.min.js|URL"; +#WPML +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/sitepress-multilingual-cms/lib/select2/select2.min.js|URL"; +#Yoast SEO +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/wordpress-seo/js/dist/select2/select2.full.min.js|URL"; +BasicRule wl:1000 "mz:$URL:/wp-content/plugins/wordpress-seo/css/dist/select2/select2.min.css|URL"; diff --git a/containers/conf/angie/naxsi_rules/whitelists/zerobin.rules b/containers/conf/angie/naxsi_rules/whitelists/zerobin.rules new file mode 100644 index 00000000..4b7b4e4f --- /dev/null +++ b/containers/conf/angie/naxsi_rules/whitelists/zerobin.rules @@ -0,0 +1,8 @@ +# Zerobin is here in directory /paste if diffrent change $URL:/paste/ below +BasicRule wl:1015 "mz:$URL:/paste/|$BODY_VAR:data"; +BasicRule wl:1315 "mz:$URL:/paste/|$HEADERS_VAR:cookie"; +BasicRule wl:1001 "mz:$URL:/paste/|$BODY_VAR:data"; +BasicRule wl:1009 "mz:$URL:/paste/|$BODY_VAR:data"; +BasicRule wl:1009 "mz:$URL:/paste/|$BODY_VAR:nickname"; +BasicRule wl:1001 "mz:$URL:/paste/|$BODY_VAR:nickname"; +BasicRule wl:1015 "mz:$URL:/paste/|$BODY_VAR:nickname"; diff --git a/containers/conf/angie/sites-available/default b/containers/conf/angie/sites-available/default new file mode 100644 index 00000000..74fb9f9f --- /dev/null +++ b/containers/conf/angie/sites-available/default @@ -0,0 +1,20 @@ +server { + listen 80 default_server backlog=2048 reuseport fastopen=256; + listen [::]:80 default_server backlog=2048 reuseport fastopen=256; + + # redirect all http traffic to https + #return 301 https://$host$request_uri; + + # Reject everything on your default IP + location / { return 444; } +} + +server { + listen 443 ssl reuseport fastopen=256 backlog=2048; + listen [::]:443 ssl reuseport fastopen=256 backlog=2048; + + # Reject everything on your default IP + location / { return 444; } + + ssl_reject_handshake on; +} diff --git a/containers/conf/angie/sites-available/example b/containers/conf/angie/sites-available/example new file mode 100644 index 00000000..8921462c --- /dev/null +++ b/containers/conf/angie/sites-available/example @@ -0,0 +1,91 @@ +## +# You should look at the following URL's in order to grasp a solid understanding +# of angie configuration files in order to fully unleash the power of angie. +# https://www.angie.com/resources/wiki/start/ +# https://www.angie.com/resources/wiki/start/topics/tutorials/config_pitfalls/ +# https://wiki.debian.org/angie/DirectoryStructure +# +# In most cases, administrators will remove this file from sites-enabled/ and +# leave it as reference inside of sites-available where it will continue to be +# updated by the angie packaging team. +# +# This file will automatically load configuration files provided by other +# applications, such as Drupal or Wordpress. These applications will be made +# available underneath a path with that package name, such as /drupal8. +# +# Please see /usr/share/doc/angie-doc/examples/ for more detailed examples. +## + +# Default server configuration +# +server { + listen 80 default_server; + listen [::]:80 default_server; + + # SSL configuration + # + # listen 443 ssl default_server; + # listen [::]:443 ssl default_server; + # + # Note: You should disable gzip for SSL traffic. + # See: https://bugs.debian.org/773332 + # + # Read up on ssl_ciphers to ensure a secure configuration. + # See: https://bugs.debian.org/765782 + # + # Self signed certs generated by the ssl-cert package + # Don't use them in a production server! + # + # include snippets/snakeoil.conf; + + root /var/www/html; + + # Add index.php to the list if you are using PHP + index index.html index.htm index.angie-debian.html; + + server_name _; + + location / { + # First attempt to serve request as file, then + # as directory, then fall back to displaying a 404. + try_files $uri $uri/ =404; + } + + # pass PHP scripts to FastCGI server + # + #location ~ \.php$ { + # include snippets/fastcgi-php.conf; + # + # # With php-fpm (or other unix sockets): + # fastcgi_pass unix:/var/run/php/php7.0-fpm.sock; + # # With php-cgi (or other tcp sockets): + # fastcgi_pass 127.0.0.1:9000; + #} + + # deny access to .htaccess files, if Apache's document root + # concurs with angie's one + # + #location ~ /\.ht { + # deny all; + #} +} + + +# Virtual Host configuration for example.com +# +# You can move that to a different file under sites-available/ and symlink that +# to sites-enabled/ to enable it. +# +#server { +# listen 80; +# listen [::]:80; +# +# server_name example.com; +# +# root /var/www/example.com; +# index index.html; +# +# location / { +# try_files $uri $uri/ =404; +# } +#} diff --git a/containers/conf/php.ini b/containers/conf/php.ini index e76c33fe..06ffdc5f 100755 --- a/containers/conf/php.ini +++ b/containers/conf/php.ini @@ -1,14 +1,18 @@ -allow_url_fopen = 0 -allow_url_include = 0 -cgi.fix_pathinfo = 0 -display_errors = 0 -display_startup_errors = 0 -expose_php = 0 -file_uploads = On -max_execution_time = 600 -max_input_time = 600 -max_input_vars = 2000 -memory_limit = 1024M -post_max_size = 32M -register_globals = Off -upload_max_filesize = 32M +allow_url_fopen=Off +allow_url_include=Off +cgi.fix_pathinfo=Off +display_errors=On +display_startup_errors=On +expose_php=Off +file_uploads=On +html_errors=On +error_prepend_string="
"
+error_append_string="
" +max_execution_time=600 +max_input_time=600 +max_input_vars=2000 +memory_limit=1024M +open_basedir="/" +post_max_size=32M +register_globals=Off +upload_max_filesize=32M diff --git a/cspell.json b/cspell.json index 6eca639e..4531447e 100644 --- a/cspell.json +++ b/cspell.json @@ -1,48 +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", + "multishipping", + "muplugin", + "phpactor", + "phpstan", + "somaxconn", + "Squiz", + "symfony", "taplo", - "phpactor" + "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/docs/JOURNAL.md b/docs/JOURNAL.md index cdc4329f..0959320d 100644 --- a/docs/JOURNAL.md +++ b/docs/JOURNAL.md @@ -1,5 +1,9 @@ # Journal de développement +## 2026-01-09 + +- Faire un modèle _Twig_ pour l'injection de données _JSON_ dans le _HTML_ d'une page. + ## 2025-06-13 ### Informations produit sous forme de grille diff --git a/docs/TESTS.md b/docs/TESTS.md new file mode 100644 index 00000000..379bb42a --- /dev/null +++ b/docs/TESTS.md @@ -0,0 +1,6 @@ +- Produits + - Aller sur tous les Produits + - La page doit correctement se charger + - Il est possible d'ajouter chaque variation au Panier + - Il n'est pas possible d'ajouter un Produit sans stock au Panier + - Le backend renvoie une erreur quand une demande d'ajout au Panier pour un Produit sans stock est malgré tout effectuée diff --git a/docs/TODO.md b/docs/TODO.md index c1ff310b..4620e408 100755 --- a/docs/TODO.md +++ b/docs/TODO.md @@ -1,3 +1,9 @@ +## 2026-02-19 + +- Créer un _timer_ et _service_ `systemd` adossés à un script réalisant un export de la BDD de production du site Haiku toutes les semaines dans le dossier `db` du répertoire. + +--- + - PAGE PANIER - [-] Bouton « Réinitialiser » pour les Articles - [-] Bouton « Réinitialiser » pour les Adresses diff --git a/docs/lol/cute.ts b/docs/lol/cute.ts index 11829959..25f91a4f 100755 --- a/docs/lol/cute.ts +++ b/docs/lol/cute.ts @@ -1,12 +1,5 @@ -const etapes = [ - "┌(・ω・)┘", - "└(・ω・)┐", - "┌(;・ω・)┘", - "└(;・ω・)┐", - "┌(;・ω・;)┘", - "└(;・ω・;)┐", -]; -const assigneTexte = (texte: string): void => ELEMENTS.BOUTON_CODE_PROMO.textContent = texte; +const etapes = ["┌(・ω・)┘", "└(・ω・)┐", "┌(;・ω・)┘", "└(;・ω・)┐", "┌(;・ω・;)┘", "└(;・ω・;)┐"]; +const assigneTexte = (texte: string): void => (ELEMENTS.BOUTON_CODE_PROMO.textContent = texte); let index = 0; const z = {}; const callback = () => { diff --git a/dprint.json b/dprint.json deleted file mode 100755 index 7e269f37..00000000 --- a/dprint.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "excludes": [ - "**/node_modules", - "**/pnpm-lock.yaml", - "./lib/", - "web/app/languages", - "web/app/plugins", - "web/app/themes/haiku-atelier-2024/assets", - "web/vendor" - ], - "exec": { - "cacheKey": "1", - "commands": [ - { "command": "prettier --ignore-unknown --write --stdin-filepath {{file_path}}", "exts": ["xml"] }, - { "command": "just --dump", "fileNames": ["justfile"], "stdin": true } - ], - "cwd": "${originConfigDir}", - "indentWidth": 2, - "lineWidth": 120, - "timeout": 30, - "useTabs": false - }, - "indentWidth": 2, - "json": { - "commentLine.forceSpaceAfterSlashes": true, - "indentWidth": 2, - "jsonTrailingCommaFiles": [".swcrc", "biome.jsonc", "settings.json", "tsconfig.json"], - "lineWidth": 120, - "newLineKind": "lf", - "preferSingleLine": true, - "trailingCommas": "never", - "useTabs": false - }, - "lineWidth": 120, - "malva": { - "alignComments": true, - "attrValueQuotes": "always", - "blockSelectorLinebreak": "wrap", - "declarationOrder": null, - "formatComments": true, - "hexCase": "lower", - "hexColorLength": "short", - "indentWidth": 2, - "keyframeSelectorNotation": "keyword", - "lineBreak": "lf", - "linebreakInPseudoParens": true, - "omitNumberLeadingZero": false, - "operatorLinebreak": "before", - "preferSingleLine": true, - "printWidth": 100, - "quotes": "alwaysDouble", - "singleLineBlockThreshold": null, - "singleLineTopLevelDeclarations": false, - "trailingComma": false, - "useTabs": false - }, - "markup": { - "closingBracketSameLine": false, - "closingTagLineBreakForEmpty": "never", - "component.selfClosing": false, - "doctypeKeywordCase": "lower", - "formatComments": true, - "html.normal.selfClosing": false, - "html.void.selfClosing": false, - "indentWidth": 2, - "lineBreak": "lf", - "maxAttrsPerLine": 1, - "printWidth": 120, - "quotes": "double", - "scriptFormatter": "dprint", - "scriptIndent": true, - "styleIndent": true, - "svg.selfClosing": true, - "useTabs": false, - "whitespaceSensitivity": "strict" - }, - "newLineKind": "lf", - "plugins": [ - "https://plugins.dprint.dev/typescript-0.95.13.wasm", - "https://plugins.dprint.dev/json-0.21.0.wasm", - "https://plugins.dprint.dev/markdown-0.20.0.wasm", - "https://plugins.dprint.dev/toml-0.7.0.wasm", - "https://plugins.dprint.dev/g-plane/malva-v0.15.1.wasm", - "https://plugins.dprint.dev/g-plane/markup_fmt-v0.25.3.wasm", - "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.1.wasm", - "https://plugins.dprint.dev/exec-0.6.0.json@a054130d458f124f9b5c91484833828950723a5af3f8ff2bd1523bd47b83b364" - ], - "toml": { - "cargo.applyConventions": true, - "comment.forceLeadingSpace": true, - "indentWidth": 2, - "lineWidth": 120, - "newLineKind": "lf", - "useTabs": false - }, - "typescript": { - "arrowFunction.useParentheses": "preferNone", - "conditionalExpression.operatorPosition": "nextLine", - "conditionalExpression.preferSingleLine": true, - "exportDeclaration.sortNamedExports": "maintain", - "importDeclaration.sortNamedImports": "maintain", - "module.sortExportDeclarations": "maintain", - "module.sortImportDeclarations": "maintain", - "quoteProps": "asNeeded", - "trailingCommas": "onlyMultiLine", - "useBraces": "whenNotSingleLine" - }, - "yaml": { - "braceSpacing": true, - "bracketSpacing": false, - "formatComments": true, - "indentBlockSequenceInMap": true, - "indentWidth": 2, - "lineBreak": "lf", - "preferSingleLine": false, - "printWidth": 120, - "quotes": "preferDouble", - "trailingComma": true, - "trimTrailingWhitespaces": true, - "trimTrailingZero": false - } -} diff --git a/eslint.config.js b/eslint.config.js deleted file mode 100755 index 4b30e56e..00000000 --- a/eslint.config.js +++ /dev/null @@ -1,61 +0,0 @@ -import js from "@eslint/js"; -import oxlint from "eslint-plugin-oxlint"; -import perfectionist from "eslint-plugin-perfectionist"; -import globals from "globals"; -import tseslint from "typescript-eslint"; - -export default tseslint.config( - js.configs.recommended, - perfectionist.configs["recommended-natural"], - ...tseslint.configs.strictTypeChecked, - ...tseslint.configs.stylisticTypeChecked, - oxlint.configs["flat/recommended"], - { - files: ["*.js", "web/app/themes/haiku-atelier-2024/src/**/*.ts"], - languageOptions: { - ecmaVersion: "latest", - globals: { - ...globals.browser, - ...globals.es2020, - }, - parserOptions: { - projectService: true, - tsconfigRootDir: import.meta.dirname, - }, - }, - rules: { - /* Utilise Array plutôt que T[]. */ - "@typescript-eslint/array-type": [ - "error", - { - default: "generic", - readonly: "generic", - }, - ], - /* L'usage d'interfaces ou de types doit être à la discrétion du développeur. */ - "@typescript-eslint/consistent-type-definitions": "off", - /* Désactive cette règle pour les fonctions fléchées pour rendre le code moins verbeux. */ - "@typescript-eslint/no-confusing-void-expression": [ - "error", - { - ignoreArrowShorthand: true, - ignoreVoidOperator: false, - }, - ], - /* Chiant avec certaines Promises. */ - "@typescript-eslint/no-misused-promises": "off", - /* Cette règle empêche l'usage de génériques précisant les types de retour de fonctions. */ - "@typescript-eslint/no-unnecessary-type-parameters": "off", - // Pour utiliser LogTape. - "@typescript-eslint/no-unused-expressions": "off", - /* Cette règle est doublon avec les règles noUnused* de TypeScript. */ - "@typescript-eslint/no-unused-vars": "off", - /* Cette règle empêche de lever des erreurs génériques (p.ex. `E extends Error`). */ - "@typescript-eslint/only-throw-error": "off", - /* Cette règle empêche le style fonctionnel « point free ». */ - "@typescript-eslint/unbound-method": "off", - /* Cette règle interdit l'usage de fonctions vides sauf pour les fonctions fléchées. */ - "no-empty-function": ["error", { allow: ["arrowFunctions"] }], - }, - }, -); diff --git a/justfile b/justfile index 205d131c..8d2c9d6c 100755 --- a/justfile +++ b/justfile @@ -1,11 +1,7 @@ set shell := ["fish", "-c"] -set unstable - -cacheFolder := ".cache" -prettierCacheFile := "prettiercache" # Recette par défaut. -default: dev +default: build-all # Liste toutes les recettes list: @@ -16,64 +12,69 @@ list: [group('php')] update: composer update - bun update + aube update -# Formatte avec Prettier et dprint. +# Formatte avec treefmt. +[group('qualité')] +treefmt: + treefmt --config-file ~/.config/treefmt/treefmt.toml . + +# Formatte avec Prettier et treefmt. [group('qualité')] format: - bun prettier \ - --cache \ - --cache-location "{{ cacheFolder }}/{{ prettierCacheFile }}" \ - --ignore-unknown \ - --parallel-workers 8 \ - --write \ - . - dprint fmt + aube x prettier \ + --cache --cache-location ".cache/prettiercache" \ + --config "cfg/prettier.config.ts" \ + --ignore-path "cfg/prettierignore" \ + --ignore-unknown \ + --parallel-workers 8 \ + --write . # TwigCsFixher -vendor/bin/twig-cs-fixer fix web/app/themes/haiku-atelier-2024/ - # Mago - mago fmt # PhpCsFixer - -vendor/bin/php-cs-fixer fix --allow-risky yes - fish scripts/format-sort-files.fish + # -vendor/bin/php-cs-fixer fix --allow-risky yes + treefmt \ + --config-file ~/.config/treefmt/treefmt.toml \ + --tree-root . \ + . # Compile, minifie et optimise Sass vers CSS. [group('css')] build-css: - @bun sass \ + @aube x sass \ --update \ "web/app/themes/haiku-atelier-2024/src/sass":"web/app/themes/haiku-atelier-2024/assets/css" - @bun lightningcss \ + @aube x lightningcss \ --bundle \ --minify \ --output-file "web/app/themes/haiku-atelier-2024/assets/css/main.min.css" \ -- "web/app/themes/haiku-atelier-2024/assets/css/main.css" - @bun lightningcss \ + @aube x lightningcss \ --bundle \ --minify \ --output-file "web/app/themes/haiku-atelier-2024/assets/css/pages/page-panier.min.css" \ -- "web/app/themes/haiku-atelier-2024/assets/css/pages/page-panier.css" - @bun lightningcss \ + @aube x lightningcss \ --bundle \ --minify \ --output-file "web/app/themes/haiku-atelier-2024/assets/css/pages/page-accueil.min.css" \ -- "web/app/themes/haiku-atelier-2024/assets/css/pages/page-accueil.css" - @bun lightningcss \ + @aube x lightningcss \ --bundle \ --minify \ --output-file "web/app/themes/haiku-atelier-2024/assets/css/pages/page-boutique.min.css" \ -- "web/app/themes/haiku-atelier-2024/assets/css/pages/page-boutique.css" - @bun lightningcss \ + @aube x lightningcss \ --bundle \ --minify \ --output-file "web/app/themes/haiku-atelier-2024/assets/css/pages/page-a-propos.min.css" \ -- "web/app/themes/haiku-atelier-2024/assets/css/pages/page-a-propos.css" - @bun lightningcss \ + @aube x lightningcss \ --bundle \ --minify \ --output-file "web/app/themes/haiku-atelier-2024/assets/css/pages/page-modele-simple.min.css" \ -- "web/app/themes/haiku-atelier-2024/assets/css/pages/page-modele-simple.css" - @bun lightningcss \ + @aube x lightningcss \ --bundle \ --minify \ --output-file "web/app/themes/haiku-atelier-2024/assets/css/pages/page-succes-commande.min.css" \ @@ -87,7 +88,12 @@ watch-css: # Compile TypeScript en JavaScript. [group('js')] build-js: - @bun vite build + aube x vite build --config "cfg/vite.config.ts" + +# Compile TypeScript à chaque changement de fichier. +[group('js')] +watch-js: + @watchexec -w "web/app/themes/haiku-atelier-2024/src/scripts" -w "web/app/themes/haiku-atelier-2024/src/scripts-effect" -- just build-js treefmt # Compile tout. [group('css')] @@ -97,30 +103,32 @@ build-all: @just build-js @just format -# Compile TypeScript à chaque changement de fichier. -[group('js')] -watch-js: - bun vite build --watch - # Vérifie le code TypeScript avec des analyseurs statiques. [group('js')] [group('qualité')] lint-js: - -bun eslint "web/app/themes/haiku-atelier-2024/src/scripts" - -bun biome check --reporter=summary "web/app/themes/haiku-atelier-2024/src/scripts" - -bun oxlint "web/app/themes/haiku-atelier-2024/src/scripts" + -aube x eslint "web/app/themes/haiku-atelier-2024/src/scripts" + -aube x oxlint \ + --config cfg/oxlint.config.ts \ + --format stylish + +fix-js: + aube x oxlint \ + --config cfg/oxlint.config.ts \ + --format stylish \ + --fix --fix-suggestions --fix-dangerously # Vérifie le code Sass avec Stylelint. [group('css')] [group('qualité')] lint-css: - -bun stylelint "web/app/themes/haiku-atelier-2024/src/sass/" --fix + -aube x stylelint --config "cfg/stylelint.config.ts" "web/app/themes/haiku-atelier-2024/src/sass/" --fix # Vérifie le code TypeScript mort avec knip [group('js')] [group('qualité')] lint-code-mort: - -bun knip + -aube x knip # Fusionne tous les changements actuels dans le commit précédent et pousse sur le répertoire distant avec Jujetsu. [group('vcs')] @@ -135,19 +143,6 @@ lint-build-format-css: -just build-css -just format -# Lance un navigateur de développement. -[group('développement')] -dev: - @/opt/cromite/chrome --remote-debugging-address=127.0.0.1 --remote-debugging-port=9222 --profile-directory=Guest "https://haikuatelier.gcch.local" & - -# Recharge le premier onglet du navigateur de développement. -[group('développement')] -reload-tab: - #!/usr/bin/fish - set -f WSURL (curl -s http://127.1:9222/json | fx '.[0].webSocketDebuggerUrl') - set -f REQUEST '{ "id": 2, "method": "Page.reload", "params": { "ignoreCache": true, "scriptToEvaluateOnLoad": "" } }' - echo $REQUEST | websocat $WSURL - # Créé l'image OCI. [group('container')] build-wordpress-container: @@ -171,4 +166,10 @@ restart-services: # Met à jour les conteneurs images des conteneurs. [group('container')] pull-images: - bun "scripts/pull-container-images.ts" + bun run "scripts/pull-container-images.ts" + +export_production_db: + fish "scripts/déclenche-sauvegarde-bdd-production.fish" + +ui_tests: + aube x playwright test --config cfg/playwright.config.ts --ui diff --git a/lib/openapi3_1.json b/lib/openapi3_1.json index b0df0736..11f08a0d 100755 --- a/lib/openapi3_1.json +++ b/lib/openapi3_1.json @@ -1,901 +1,18598 @@ { - "openapi": "3.1.0", - "info": { - "title": "Haiku Atelier API", - "description": "", - "version": "6.6.1", - "contact": { "name": "Haiku Atelier", "url": "https:/haikuatelier.fr.ddev.site", "email": "contact@gcch.fr" } - }, - "servers": [{ "url": "https:/haikuatelier.fr.ddev.site/wp-json" }], - "tags": [ - { "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": "" } - ], - "security": [], "components": { "schemas": { - "shop_coupon": { + "Count Low in Stock Items": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shop_coupon", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the object.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true + "properties": { + "total": "integer" }, - "code": { "description": "Coupon code.", "type": "string", "context": ["view", "edit"] }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "context": ["view", "edit"] + "type": "object" + }, + "title": "Count Low in Stock Items", + "type": "object" + }, + "Install Async Schema": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "properties": { + "job_id": "integer", + "status": { + "enum": [ + "complete", + "failed", + "pending" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "Install Async Schema", + "type": "object" + }, + "Install and Activate Schema": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "properties": { + "activate": { + "properties": { + "activated": { + "items": { + "type": "string" + }, + "type": "array" + }, + "active": { + "items": { + "type": "string" + }, + "type": "array" + }, + "errors": { + "properties": { + "error_data": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + }, + "errors": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "install": { + "properties": { + "errors": { + "properties": { + "error_data": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + }, + "errors": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "installed": { + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "title": "Install and Activate Schema", + "type": "object" + }, + "ai/business-description": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/business-description", + "type": "object" + }, + "ai/images": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/images", + "type": "object" + }, + "ai/patterns": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/patterns", + "type": "object" + }, + "ai/product": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/product", + "type": "object" + }, + "ai/products": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/products", + "type": "object" + }, + "ai/store-info": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/store-info", + "type": "object" + }, + "ai/store-title": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/store-title", + "type": "object" + }, + "application-password": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "app_id": { + "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": [ + "edit", + "view" + ], + "description": "The GMT date the application password was created.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "last_ip": { + "context": [ + "edit", + "view" + ], + "description": "The IP address the application password was last used by.", + "format": "ip", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "last_used": { + "context": [ + "edit", + "view" + ], + "description": "The GMT date the application password was last used.", + "format": "date-time", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The name of the application password.", + "minLength": 1, + "pattern": ".*\\S.*", + "required": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "The generated password. Only available after adding an application.", + "readonly": true, + "type": "string" + }, + "uuid": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The unique identifier for the application password.", + "format": "uuid", + "readonly": true, + "type": "string" + } + }, + "title": "application-password", + "type": "object" + }, + "attachment": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "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" + }, + "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" + }, + "title": "The current user can change the author on this post." + } + ], + "properties": { + "alt_text": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Alternative text to display when attachment is not displayed.", + "type": "string" + }, + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The attachment caption.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Caption for the attachment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML caption for the attachment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "comment_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "The attachment description.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Description for the attachment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML description for the attachment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "media_details": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Details about the media file, specific to its type.", + "readonly": true, + "type": "object" + }, + "media_type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Attachment type.", + "enum": [ + "file", + "image" + ], + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "mime_type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The attachment MIME type.", + "readonly": true, + "type": "string" + }, + "missing_image_sizes": { + "context": [ + "edit" + ], + "description": "List of the missing image sizes of the attachment.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "ping_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "post": { + "context": [ + "edit", + "view" + ], + "description": "The ID for the associated post of the attachment.", + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "source_url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the original attachment file.", + "format": "uri", + "readonly": true, + "type": "string" }, "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "context": ["view", "edit"] + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" }, - "date_created": { - "description": "The date the coupon was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" }, - "date_created_gmt": { - "description": "The date the coupon was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the coupon was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the coupon was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "default": "fixed_cart", - "enum": ["percent", "fixed_cart", "fixed_product"], - "context": ["view", "edit"] - }, - "description": { "description": "Coupon description.", "type": "string", "context": ["view", "edit"] }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "usage_count": { - "description": "Number of times the coupon has been used already.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "context": ["view", "edit"] - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "context": ["view", "edit"] - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "context": ["view", "edit"] - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "context": ["view", "edit"] - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "context": ["view", "edit"] - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"] - }, - "used_by": { - "description": "List of user IDs (or guest email addresses) that have used the coupon.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" } - } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" } - } + }, + "title": "attachment", + "type": "object" }, "batch": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "batch", - "type": "object", "properties": { "create": { + "context": [ + "edit", + "view" + ], "description": "List of created resources.", - "type": "array", - "context": ["view", "edit"], - "items": { "type": "object" } - }, - "update": { - "description": "List of updated resources.", - "type": "array", - "context": ["view", "edit"], - "items": { "type": "object" } + "items": { + "type": "object" + }, + "type": "array" }, "delete": { + "context": [ + "edit", + "view" + ], "description": "List of deleted resources.", - "type": "array", - "context": ["view", "edit"], - "items": { "type": "integer" } + "items": { + "type": "integer" + }, + "type": "array" + }, + "update": { + "context": [ + "edit", + "view" + ], + "description": "List of updated resources.", + "items": { + "type": "object" + }, + "type": "array" } - } + }, + "title": "batch", + "type": "object" }, - "customer_download": { + "block-directory-item": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "customer_download", - "type": "object", "properties": { - "download_id": { "description": "Download ID.", "type": "string", "context": ["view"], "readonly": true }, - "download_url": { - "description": "Download file URL.", - "type": "string", - "context": ["view"], - "readonly": true + "active_installs": { + "context": [ + "view" + ], + "description": "The number of sites that have activated this block.", + "type": "integer" }, - "product_id": { - "description": "Downloadable product ID.", - "type": "integer", - "context": ["view"], - "readonly": true + "author": { + "context": [ + "view" + ], + "description": "The WordPress.org username of the block author.", + "type": "string" }, - "product_name": { "description": "Product name.", "type": "string", "context": ["view"], "readonly": true }, - "download_name": { - "description": "Downloadable file name.", - "type": "string", - "context": ["view"], - "readonly": true + "author_block_count": { + "context": [ + "view" + ], + "description": "The number of blocks published by the same author.", + "type": "integer" }, - "order_id": { "description": "Order ID.", "type": "integer", "context": ["view"], "readonly": true }, - "order_key": { "description": "Order key.", "type": "string", "context": ["view"], "readonly": true }, - "downloads_remaining": { - "description": "Number of downloads remaining.", - "type": "string", - "context": ["view"], - "readonly": true + "author_block_rating": { + "context": [ + "view" + ], + "description": "The average rating of blocks published by the same author.", + "type": "number" }, - "access_expires": { - "description": "The date when download access expires, in the site's timezone.", - "type": "string", - "context": ["view"], - "readonly": true + "description": { + "context": [ + "view" + ], + "description": "A short description of the block, in human readable format.", + "type": "string" }, - "access_expires_gmt": { - "description": "The date when download access expires, as GMT.", - "type": "string", - "context": ["view"], - "readonly": true + "humanized_updated": { + "context": [ + "view" + ], + "description": "The date when the block was last updated, in fuzzy human readable format.", + "type": "string" }, - "file": { - "description": "File details.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "name": { "description": "File name.", "type": "string", "context": ["view"], "readonly": true }, - "file": { "description": "File URL.", "type": "string", "context": ["view"], "readonly": true } - } + "icon": { + "context": [ + "view" + ], + "description": "The block icon.", + "format": "uri", + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "The block slug.", + "type": "string" + }, + "last_updated": { + "context": [ + "view" + ], + "description": "The date when the block was last updated.", + "format": "date-time", + "type": "string" + }, + "name": { + "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" + }, + "title": { + "context": [ + "view" + ], + "description": "The block title, in human readable format.", + "type": "string" } - } + }, + "title": "block-directory-item", + "type": "object" + }, + "block-pattern": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "block_types": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Block types that the pattern is intended to be used with.", + "readonly": true, + "type": "array" + }, + "categories": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern's category slugs.", + "readonly": true, + "type": "array" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern content.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern detailed description.", + "readonly": true, + "type": "string" + }, + "inserter": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Determines whether the pattern is visible in inserter.", + "readonly": true, + "type": "boolean" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern keywords.", + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern name.", + "readonly": true, + "type": "string" + }, + "post_types": { + "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": [ + "edit", + "embed", + "view" + ], + "description": "Where the pattern comes from e.g. core", + "enum": [ + "core", + "pattern-directory/core", + "pattern-directory/featured", + "pattern-directory/theme", + "plugin", + "theme" + ], + "readonly": true, + "type": "string" + }, + "template_types": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An array of template types where the pattern fits.", + "readonly": true, + "type": "array" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern title, in human readable format.", + "readonly": true, + "type": "string" + }, + "viewport_width": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern viewport width for inserter preview.", + "readonly": true, + "type": "number" + } + }, + "title": "block-pattern", + "type": "object" + }, + "block-pattern-category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The category description in a human-readable format.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The category label, in human readable format.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The category name.", + "readonly": true, + "type": "string" + } + }, + "title": "block-pattern-category", + "type": "object" + }, + "block-type": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "allowed_blocks": { + "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" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "ancestor": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Ancestor blocks.", + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "api_version": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 1, + "description": "Version of block API.", + "readonly": true, + "type": "integer" + }, + "attributes": { + "additionalProperties": { + "type": "object" + }, + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block attributes.", + "properties": [], + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "block_hooks": { + "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": [ + "after", + "before", + "first_child", + "last_child" + ], + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "category": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block category.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of block type.", + "readonly": true, + "type": "string" + }, + "editor_script": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Editor script handle. DEPRECATED: Use `editor_script_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "editor_script_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Editor script handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "editor_style": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Editor style handle. DEPRECATED: Use `editor_style_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "editor_style_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Editor style handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "example": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block example.", + "properties": { + "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" + }, + "innerBlocks": { + "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", + "type": "array" + }, + "name": { + "description": "The name of the inner block.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "icon": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Icon of block type.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "is_dynamic": { + "context": [ + "edit", + "embed", + "view" + ], + "default": false, + "description": "Is the block dynamically rendered.", + "readonly": true, + "type": "boolean" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block keywords.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique name identifying the block type.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "readonly": true, + "required": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Parent blocks.", + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "provides_context": { + "additionalProperties": { + "type": "string" + }, + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Context provided by blocks of this type.", + "properties": [], + "readonly": true, + "type": "object" + }, + "script": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "script_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public facing and editor script handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "selectors": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Custom CSS selectors.", + "properties": [], + "readonly": true, + "type": "object" + }, + "style": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "style_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public facing and editor style handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "styles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block style variations.", + "items": { + "properties": { + "inline_style": { + "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" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "supports": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block supports.", + "properties": [], + "readonly": true, + "type": "object" + }, + "textdomain": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public text domain.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of block type.", + "readonly": true, + "type": "string" + }, + "uses_context": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Context values inherited by blocks of this type.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "variations": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block variations.", + "items": { + "properties": { + "attributes": { + "description": "The initial values for attributes.", + "type": "object" + }, + "category": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block category.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "A detailed variation description.", + "required": false, + "type": "string" + }, + "example": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block example.", + "properties": { + "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" + }, + "innerBlocks": { + "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", + "type": "array" + }, + "name": { + "description": "The name of the inner block.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "icon": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Icon of block type.", + "readonly": true, + "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" + }, + "innerBlocks": { + "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", + "type": "array" + }, + "name": { + "description": "The name of the inner block.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "isDefault": { + "default": false, + "description": "Indicates whether the current variation is the default one.", + "required": false, + "type": "boolean" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block keywords.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "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" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "title": { + "description": "A human-readable variation title.", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "view_script": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public facing script handle. DEPRECATED: Use `view_script_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "view_script_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public facing script handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "view_script_module_ids": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public-facing script module IDs.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "view_style_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public-facing style handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + } + }, + "title": "block-type", + "type": "object" + }, + "cart": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set billing address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "List of applied basket coupons.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount applied by this coupon.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount applied by this coupon.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "cross_sells": { + "context": [ + "edit", + "view" + ], + "description": "List of cross-sells items related to basket items.", + "items": { + "properties": { + "add_to_cart": { + "context": [ + "edit", + "view" + ], + "description": "Add to basket button parameters.", + "properties": { + "description": { + "context": [ + "edit", + "view" + ], + "description": "Button description.", + "readonly": true, + "type": "string" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity that can be added to the basket.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity that can be added to the basket.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "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": [ + "edit", + "view" + ], + "description": "Button text.", + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "edit", + "view" + ], + "description": "Add to basket URL.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "attributes": { + "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": [ + "edit", + "view" + ], + "description": "True if this attribute is used by product variations.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "The attribute name.", + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "The attribute taxonomy, or null if the attribute is not taxonomy based.", + "readonly": true, + "type": "string" + }, + "terms": { + "context": [ + "edit", + "view" + ], + "description": "List of assigned attribute terms.", + "items": { + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "If this is a default attribute", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The term ID, or 0 if the attribute is not a global attribute.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "The term name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "The term slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "average_rating": { + "context": [ + "edit", + "view" + ], + "description": "Reviews average rating.", + "readonly": true, + "type": "string" + }, + "categories": { + "context": [ + "edit", + "view" + ], + "description": "List of categories, if applicable.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID", + "readonly": true, + "type": "number" + }, + "link": { + "context": [ + "edit", + "view" + ], + "description": "Category link", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Category slug", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, + "has_options": { + "context": [ + "edit", + "view" + ], + "description": "Does the product have additional options before it can be added to the basket?", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "readonly": true, + "type": "string" + }, + "sizes": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "readonly": true, + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "readonly": true, + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "is_in_stock": { + "context": [ + "edit", + "view" + ], + "description": "Is the product in stock?", + "readonly": true, + "type": "boolean" + }, + "is_on_backorder": { + "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": [ + "edit", + "view" + ], + "description": "Is the product purchasable?", + "readonly": true, + "type": "boolean" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "on_sale": { + "context": [ + "edit", + "view" + ], + "description": "Is the product on sale?", + "readonly": true, + "type": "boolean" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "ID of the parent product, if applicable.", + "readonly": true, + "type": "integer" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "price_html": { + "context": [ + "edit", + "view" + ], + "description": "Price string formatted as HTML.", + "readonly": true, + "type": "string" + }, + "prices": { + "context": [ + "edit", + "view" + ], + "description": "Price data provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "review_count": { + "context": [ + "edit", + "view" + ], + "description": "Amount of reviews that the product has.", + "readonly": true, + "type": "integer" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Product slug.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "List of tags, if applicable.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tag ID", + "readonly": true, + "type": "number" + }, + "link": { + "context": [ + "edit", + "view" + ], + "description": "Tag link", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tag name", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Tag slug", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Product type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Product variation attributes, if applicable.", + "readonly": true, + "type": "string" + }, + "variations": { + "context": [ + "edit", + "view" + ], + "description": "List of variation IDs, if applicable.", + "items": { + "properties": { + "attributes": { + "context": [ + "edit", + "view" + ], + "description": "List of variation attributes.", + "items": { + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "The attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "The assigned attribute.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "errors": { + "context": [ + "edit", + "view" + ], + "description": "List of basket item errors, for example, items in the basket which are out of stock.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Error code", + "readonly": true, + "type": "string" + }, + "message": { + "context": [ + "edit", + "view" + ], + "description": "Error message", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, + "fees": { + "context": [ + "edit", + "view" + ], + "description": "List of basket fees.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the fee within the basket.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Fee total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Total amount for this fee.", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax amount for this fee.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "has_calculated_shipping": { + "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": [ + "edit", + "view" + ], + "description": "List of basket items.", + "items": { + "properties": { + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "True if backorders are allowed past stock availability.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "catalog_visibility": { + "context": [ + "edit", + "view" + ], + "description": "Whether the product is visible in the catalogue", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The item product or variation ID.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "readonly": true, + "type": "string" + }, + "sizes": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "readonly": true, + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "readonly": true, + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "item_data": { + "context": [ + "edit", + "view" + ], + "description": "Metadata related to the item", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Optionally, how the metadata value should be displayed to the user.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the metadata.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Value of the metadata.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item.", + "readonly": true, + "type": "string" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "prices": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "raw_prices": { + "context": [ + "edit", + "view" + ], + "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", + "properties": { + "precision": { + "context": [ + "edit", + "view" + ], + "description": "Decimal precision of the returned prices.", + "readonly": true, + "type": "integer" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of this item.", + "readonly": true, + "type": "number" + }, + "quantity_limits": { + "context": [ + "edit", + "view" + ], + "description": "How the quantity of this item should be controlled, for example, any limits in place.", + "properties": { + "editable": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "If the quantity is editable or fixed.", + "readonly": true, + "type": "boolean" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "show_backorder_badge": { + "context": [ + "edit", + "view" + ], + "description": "True if the product is on backorder.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Stock keeping unit, if applicable.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "Item total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "line_subtotal": { + "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": [ + "edit", + "view" + ], + "description": "Line subtotal tax.", + "readonly": true, + "type": "string" + }, + "line_total": { + "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": [ + "edit", + "view" + ], + "description": "Line total tax.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "items_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of items in the basket.", + "readonly": true, + "type": "integer" + }, + "items_weight": { + "context": [ + "edit", + "view" + ], + "description": "Total weight (in grams) of all products in the basket.", + "readonly": true, + "type": "number" + }, + "needs_payment": { + "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": [ + "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": [ + "edit", + "view" + ], + "description": "List of available payment method IDs that can be used to process the order.", + "readonly": true, + "type": "array" + }, + "payment_requirements": { + "context": [ + "edit", + "view" + ], + "description": "List of required payment gateway features to process the order.", + "readonly": true, + "type": "array" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set shipping address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "shipping_rates": { + "context": [ + "edit", + "view" + ], + "description": "List of available shipping rates for the basket.", + "items": { + "properties": { + "destination": { + "context": [ + "edit", + "view" + ], + "description": "Shipping destination address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "First line of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Second line of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "ISO code for the country of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Zip or Postcode of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code, or name, for the state, province, or district of the address being shipped to.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "items": { + "context": [ + "edit", + "view" + ], + "description": "List of basket items the returned shipping rates apply to.", + "items": { + "properties": { + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item within the basket.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the item.", + "readonly": true, + "type": "string" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of the item in the current package.", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the package.", + "readonly": true, + "type": "string" + }, + "package_id": { + "context": [ + "edit", + "view" + ], + "description": "The ID of the package the shipping rates belong to.", + "readonly": true, + "type": [ + "integer", + "string" + ] + }, + "shipping_rates": { + "context": [ + "edit", + "view" + ], + "description": "List of shipping rates.", + "items": { + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "delivery_time": { + "context": [ + "edit", + "view" + ], + "description": "Delivery time estimate text, e.g. 3-5 business days.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Description of the shipping rate, e.g. Dispatched via Royal Mail.", + "readonly": true, + "type": "string" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Instance ID of the shipping method that provided the rate.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data attached to the shipping rate.", + "items": { + "properties": { + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "ID of the shipping method that provided the rate.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the shipping rate, e.g. Express shipping.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Price of this shipping rate using the smallest unit of the currency.", + "readonly": true, + "type": "string" + }, + "rate_id": { + "context": [ + "edit", + "view" + ], + "description": "ID of the shipping rate.", + "readonly": true, + "type": "string" + }, + "selected": { + "context": [ + "edit", + "view" + ], + "description": "True if this is the rate currently selected by the customer for the basket.", + "readonly": true, + "type": "boolean" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Taxes applied to this shipping rate using the smallest unit of the currency.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Basket total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Lines of taxes applied to items and shipping.", + "items": { + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "The name of the tax.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "The amount of tax charged.", + "readonly": true, + "type": "string" + }, + "rate": { + "context": [ + "edit", + "view" + ], + "description": "The rate at which tax is applied.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_fees": { + "context": [ + "edit", + "view" + ], + "description": "Total price of any applied fees.", + "readonly": true, + "type": "string" + }, + "total_fees_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on fees.", + "readonly": true, + "type": "string" + }, + "total_items": { + "context": [ + "edit", + "view" + ], + "description": "Total price of items in the basket.", + "readonly": true, + "type": "string" + }, + "total_items_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on items in the basket.", + "readonly": true, + "type": "string" + }, + "total_price": { + "context": [ + "edit", + "view" + ], + "description": "Total price the customer will pay.", + "readonly": true, + "type": "string" + }, + "total_shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total price of shipping. If shipping has not been calculated, a null response will be sent.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax applied to items and shipping.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "cart", + "type": "object" + }, + "cart-extensions": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "cart-extensions", + "type": "object" + }, + "cart_coupon": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount applied by this coupon.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount applied by this coupon.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "cart_coupon", + "type": "object" + }, + "cart_item": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "True if backorders are allowed past stock availability.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "catalog_visibility": { + "context": [ + "edit", + "view" + ], + "description": "Whether the product is visible in the catalogue", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The item product or variation ID.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "item_data": { + "context": [ + "edit", + "view" + ], + "description": "Metadata related to the item", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Optionally, how the metadata value should be displayed to the user.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the metadata.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Value of the metadata.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item.", + "readonly": true, + "type": "string" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "prices": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "raw_prices": { + "context": [ + "edit", + "view" + ], + "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", + "properties": { + "precision": { + "context": [ + "edit", + "view" + ], + "description": "Decimal precision of the returned prices.", + "readonly": true, + "type": "integer" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of this item.", + "readonly": true, + "type": "number" + }, + "quantity_limits": { + "context": [ + "edit", + "view" + ], + "description": "How the quantity of this item should be controlled, for example, any limits in place.", + "properties": { + "editable": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "If the quantity is editable or fixed.", + "readonly": true, + "type": "boolean" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "show_backorder_badge": { + "context": [ + "edit", + "view" + ], + "description": "True if the product is on backorder.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Stock keeping unit, if applicable.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "Item total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "line_subtotal": { + "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": [ + "edit", + "view" + ], + "description": "Line subtotal tax.", + "readonly": true, + "type": "string" + }, + "line_total": { + "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": [ + "edit", + "view" + ], + "description": "Line total tax.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "title": "cart_item", + "type": "object" + }, + "category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "category" + ], + "readonly": true, + "type": "string" + } + }, + "title": "category", + "type": "object" + }, + "checkout": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "additional_fields": { + "context": [ + "edit", + "view" + ], + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "create_account": { + "context": [ + "edit", + "view" + ], + "description": "Whether to create a new user account as part of order processing.", + "type": "boolean" + }, + "customer_id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID if registered. Will return 0 for guests.", + "readonly": true, + "type": "integer" + }, + "customer_note": { + "context": [ + "edit", + "view" + ], + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": "object" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID to process during checkout.", + "readonly": true, + "type": "integer" + }, + "order_key": { + "context": [ + "edit", + "view" + ], + "description": "Order key used to check validity or protect access to certain order data.", + "readonly": true, + "type": "string" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order number used for display.", + "readonly": true, + "type": "string" + }, + "payment_method": { + "context": [ + "edit", + "view" + ], + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "type": "string" + }, + "payment_result": { + "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" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "payment_status": { + "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", + "readonly": true, + "type": "string" + }, + "redirect_url": { + "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status. Payment providers will update this value after payment.", + "readonly": true, + "type": "string" + } + }, + "title": "checkout", + "type": "object" + }, + "checkout-order": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "additional_fields": { + "context": [ + "edit", + "view" + ], + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "customer_id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID if registered. Will return 0 for guests.", + "readonly": true, + "type": "integer" + }, + "customer_note": { + "context": [ + "edit", + "view" + ], + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": "object" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID to process during checkout.", + "readonly": true, + "type": "integer" + }, + "order_key": { + "context": [ + "edit", + "view" + ], + "description": "Order key used to check validity or protect access to certain order data.", + "readonly": true, + "type": "string" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order number used for display.", + "readonly": true, + "type": "string" + }, + "payment_method": { + "context": [ + "edit", + "view" + ], + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "type": "string" + }, + "payment_result": { + "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" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "payment_status": { + "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", + "readonly": true, + "type": "string" + }, + "redirect_url": { + "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status. Payment providers will update this value after payment.", + "readonly": true, + "type": "string" + } + }, + "title": "checkout-order", + "type": "object" + }, + "comment": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_avatar_urls": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URLs for the comment author.", + "properties": { + "24": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 24 pixels.", + "format": "uri", + "type": "string" + }, + "48": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 48 pixels.", + "format": "uri", + "type": "string" + }, + "96": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 96 pixels.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "author_email": { + "context": [ + "edit" + ], + "description": "Email address for the comment author.", + "format": "email", + "type": "string" + }, + "author_ip": { + "context": [ + "edit" + ], + "description": "IP address for the comment author.", + "format": "ip", + "type": "string" + }, + "author_name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL for the comment author.", + "format": "uri", + "type": "string" + }, + "author_user_agent": { + "context": [ + "edit" + ], + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The content for the comment.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Content for the comment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the comment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the comment was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the comment.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the comment.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 0, + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "context": [ + "edit", + "view" + ], + "default": 0, + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "State of the comment.", + "type": "string" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of the comment.", + "readonly": true, + "type": "string" + } + }, + "title": "comment", + "type": "object" }, "customer": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "customer", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true + "avatar_url": { + "context": [ + "edit", + "view" + ], + "description": "Avatar URL.", + "readonly": true, + "type": "string" + }, + "billing": { + "context": [ + "edit", + "view" + ], + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "type": "object" }, "date_created": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "date_created_gmt": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "date_modified": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "date_modified_gmt": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "email": { + "context": [ + "edit", + "view" + ], "description": "The email address for the customer.", - "type": "string", "format": "email", - "context": ["view", "edit"] + "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Customer last name.", "type": "string", "context": ["view", "edit"] }, - "role": { "description": "Customer role.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "username": { "description": "Customer login name.", "type": "string", "context": ["view", "edit"] }, - "password": { "description": "Customer password.", "type": "string", "context": ["edit"] }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { "description": "ISO code of the country.", "type": "string", "context": ["view", "edit"] }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": ["view", "edit"] - }, - "phone": { "description": "Phone number.", "type": "string", "context": ["view", "edit"] } - } + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer first name.", + "type": "string" }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { "description": "ISO code of the country.", "type": "string", "context": ["view", "edit"] } - } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, "is_paying_customer": { + "context": [ + "edit", + "view" + ], "description": "Is the customer a paying customer?", - "type": "bool", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "bool" }, - "orders_count": { - "description": "Quantity of orders made by the customer.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total_spent": { - "description": "Total amount spent.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "avatar_url": { - "description": "Avatar URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer last name.", + "type": "string" }, "meta_data": { + "context": [ + "edit", + "view" + ], "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], "items": { - "type": "object", "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } + "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": [ + "edit", + "view" + ], + "description": "Quantity of orders made by the customer.", + "readonly": true, + "type": "integer" + }, + "password": { + "context": [ + "edit" + ], + "description": "Customer password.", + "type": "string" + }, + "role": { + "context": [ + "edit", + "view" + ], + "description": "Customer role.", + "readonly": true, + "type": "string" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" } - } + }, + "type": "object" + }, + "total_spent": { + "context": [ + "edit", + "view" + ], + "description": "Total amount spent.", + "readonly": true, + "type": "string" + }, + "username": { + "context": [ + "edit", + "view" + ], + "description": "Customer login name.", + "type": "string" } - } + }, + "title": "customer", + "type": "object" + }, + "customer_download": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "access_expires": { + "context": [ + "view" + ], + "description": "The date when download access expires, in the site's timezone.", + "readonly": true, + "type": "string" + }, + "access_expires_gmt": { + "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_name": { + "context": [ + "view" + ], + "description": "Downloadable file name.", + "readonly": true, + "type": "string" + }, + "download_url": { + "context": [ + "view" + ], + "description": "Download file URL.", + "readonly": true, + "type": "string" + }, + "downloads_remaining": { + "context": [ + "view" + ], + "description": "Number of downloads remaining.", + "readonly": true, + "type": "string" + }, + "file": { + "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" + } + }, + "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" + }, + "product_id": { + "context": [ + "view" + ], + "description": "Downloadable product ID.", + "readonly": true, + "type": "integer" + }, + "product_name": { + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + } + }, + "title": "customer_download", + "type": "object" + }, + "data_continents": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "view" + ], + "description": "2 character continent code.", + "readonly": true, + "type": "string" + }, + "countries": { + "context": [ + "view" + ], + "description": "List of countries on this continent.", + "items": { + "context": [ + "view" + ], + "properties": { + "code": { + "context": [ + "view" + ], + "description": "ISO3166 alpha-2 country code.", + "readonly": true, + "type": "string" + }, + "currency_code": { + "context": [ + "view" + ], + "description": "Default ISO4127 alpha-3 currency code for the country.", + "readonly": true, + "type": "string" + }, + "currency_pos": { + "context": [ + "view" + ], + "description": "Currency symbol position for this country.", + "readonly": true, + "type": "string" + }, + "decimal_sep": { + "context": [ + "view" + ], + "description": "Decimal separator for displayed prices for this country.", + "readonly": true, + "type": "string" + }, + "dimension_unit": { + "context": [ + "view" + ], + "description": "The unit lengths are defined in for this country.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of country.", + "readonly": true, + "type": "string" + }, + "num_decimals": { + "context": [ + "view" + ], + "description": "Number of decimal points shown in displayed prices for this country.", + "readonly": true, + "type": "integer" + }, + "states": { + "context": [ + "view" + ], + "description": "List of states in this country.", + "items": { + "context": [ + "view" + ], + "properties": { + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of state.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "thousand_sep": { + "context": [ + "view" + ], + "description": "Thousands separator for displayed prices in this country.", + "readonly": true, + "type": "string" + }, + "weight_unit": { + "context": [ + "view" + ], + "description": "The unit weights are defined in for this country.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of continent.", + "readonly": true, + "type": "string" + } + }, + "title": "data_continents", + "type": "object" + }, + "data_countries": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "view" + ], + "description": "ISO3166 alpha-2 country code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of country.", + "readonly": true, + "type": "string" + }, + "states": { + "context": [ + "view" + ], + "description": "List of states in this country.", + "items": { + "context": [ + "view" + ], + "properties": { + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of state.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "title": "data_countries", + "type": "object" + }, + "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" + } + }, + "title": "data_currencies", + "type": "object" + }, + "data_download_ips": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "user_ip_address": { + "context": [ + "view" + ], + "description": "IP address.", + "readonly": true, + "type": "string" + } + }, + "title": "data_download_ips", + "type": "object" + }, + "data_index": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "Data resource description.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "Data resource ID.", + "readonly": true, + "type": "string" + } + }, + "title": "data_index", + "type": "object" + }, + "font-collection": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "categories": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The categories for the font collection.", + "type": "array" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The description for the font collection.", + "type": "string" + }, + "font_families": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The font families for the font collection.", + "type": "array" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The name for the font collection.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the font collection.", + "readonly": true, + "type": "string" + } + }, + "title": "font-collection", + "type": "object" + }, + "leaderboard": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "headers": { + "context": [ + "view" + ], + "description": "Table headers.", + "items": { + "properties": { + "label": { + "context": [ + "edit", + "view" + ], + "description": "Table column header.", + "readonly": true, + "type": "string" + } + }, + "type": "array" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "view" + ], + "description": "Leaderboard ID.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "view" + ], + "description": "Displayed title for the leaderboard.", + "readonly": true, + "type": "string" + }, + "rows": { + "context": [ + "view" + ], + "description": "Table rows.", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Table cell display.", + "readonly": true, + "type": "string" + }, + "format": { + "context": [ + "view" + ], + "description": "Table cell format.", + "enum": [ + "currency", + "number" + ], + "readonly": true, + "required": false, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Table cell value.", + "readonly": true, + "type": "string" + } + }, + "type": "array" + }, + "readonly": true, + "type": "array" + } + }, + "title": "leaderboard", + "type": "object" + }, + "marketing_campaign": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "channel": { + "context": [ + "view" + ], + "description": "The unique identifier for the marketing channel that this campaign belongs to.", + "readonly": true, + "type": "string" + }, + "cost": { + "context": [ + "view" + ], + "description": "Cost of the marketing campaign.", + "properties": { + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "view" + ], + "description": "The unique identifier for the marketing campaign.", + "readonly": true, + "type": "string" + }, + "manage_url": { + "context": [ + "view" + ], + "description": "URL to the campaign management page.", + "readonly": true, + "type": "string" + }, + "sales": { + "context": [ + "view" + ], + "description": "Sales of the marketing campaign.", + "properties": { + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "title": { + "context": [ + "view" + ], + "description": "Title of the marketing campaign.", + "readonly": true, + "type": "string" + } + }, + "title": "marketing_campaign", + "type": "object" + }, + "marketing_campaign_type": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "channel": { + "context": [ + "view" + ], + "description": "The marketing channel that this campaign type belongs to.", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "The name of the marketing channel that this campaign type belongs to.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "The unique identifier of the marketing channel that this campaign type belongs to.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "create_url": { + "context": [ + "view" + ], + "description": "URL to the create campaign page for this campaign type.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "view" + ], + "description": "Description of the marketing campaign type.", + "readonly": true, + "type": "string" + }, + "icon_url": { + "context": [ + "view" + ], + "description": "URL to an image/icon for the campaign type.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "The unique identifier for the marketing campaign type.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Name of the marketing campaign type.", + "readonly": true, + "type": "string" + } + }, + "title": "marketing_campaign_type", + "type": "object" + }, + "marketing_channel": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "Description of the marketing channel.", + "readonly": true, + "type": "string" + }, + "errors_count": { + "context": [ + "view" + ], + "description": "Number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).", + "readonly": true, + "type": "string" + }, + "icon": { + "context": [ + "view" + ], + "description": "Path to the channel icon.", + "readonly": true, + "type": "string" + }, + "is_setup_completed": { + "context": [ + "view" + ], + "description": "Whether or not the marketing channel is set up.", + "readonly": true, + "type": "boolean" + }, + "name": { + "context": [ + "view" + ], + "description": "Name of the marketing channel.", + "readonly": true, + "type": "string" + }, + "product_listings_status": { + "context": [ + "view" + ], + "description": "Status of the marketing channel's product listings.", + "readonly": true, + "type": "string" + }, + "settings_url": { + "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" + ], + "description": "Unique identifier string for the marketing channel extension, also known as the plugin slug.", + "readonly": true, + "type": "string" + } + }, + "title": "marketing_channel", + "type": "object" + }, + "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" + ], + "items": { + "context": [ + "view" + ], + "properties": { + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "tags": { + "context": [ + "view" + ], + "items": { + "context": [ + "view" + ], + "properties": { + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "title": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "title": "marketing_recommendation", + "type": "object" + }, + "menu-location": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The description of the menu location.", + "readonly": true, + "type": "string" + }, + "menu": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the assigned menu.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The name of the menu location.", + "readonly": true, + "type": "string" + } + }, + "title": "menu-location", + "type": "object" + }, + "nav_menu": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "auto_add": { + "context": [ + "edit", + "view" + ], + "description": "Whether to automatically add top-level pages to this menu.", + "type": "boolean" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "locations": { + "context": [ + "edit", + "view" + ], + "description": "The locations assigned to the menu.", + "items": { + "type": "string" + }, + "type": "array" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "title": "nav_menu", + "type": "object" + }, + "nav_menu_item": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the nav_menu taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the nav_menu taxonomy." + }, + { + "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" + }, + "title": "Get linked object." + } + ], + "properties": { + "attr_title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Text for the title attribute of the link element for this menu item.", + "type": "string" + }, + "classes": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Class names for the link element of this menu item.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The description of this menu item.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 0, + "description": "Unique identifier for the object.", + "minimum": 0, + "readonly": true, + "type": "integer" + }, + "invalid": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the menu item represents an object that no longer exists .", + "readonly": true, + "type": "boolean" + }, + "menu_order": { + "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": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "object": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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": [ + "edit", + "embed", + "view" + ], + "default": 0, + "description": "The ID for the parent of the object.", + "minimum": 0, + "type": "integer" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "publish", + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "target": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The target attribute of the link element for this menu item.", + "enum": [ + "", + "_blank" + ], + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the object.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "custom", + "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], + "type": "string" + }, + "type_label": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The singular label used to describe this type of menu item.", + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The URL to which this menu item points.", + "format": "uri", + "type": "string" + }, + "xfn": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The XFN relationship expressed in the link of this menu item.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "nav_menu_item", + "type": "object" + }, + "nav_menu_item-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the revision, as it exists in the database.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the object.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + } + }, + "title": "nav_menu_item-revision", + "type": "object" + }, + "navigation-fallback": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The unique identifier for the Navigation Menu.", + "readonly": true, + "type": "integer" + } + }, + "title": "navigation-fallback", + "type": "object" + }, + "note": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "actions": { + "context": [ + "edit", + "view" + ], + "description": "An array of actions, if any, for the note.", + "readonly": true, + "type": "array" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "Content of the note.", + "readonly": true, + "type": "string" + }, + "content_data": { + "context": [ + "edit", + "view" + ], + "description": "Content data for the note. JSON string. Available for re-localisation.", + "readonly": true, + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "Date the note was created.", + "readonly": true, + "type": "string" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date the note was created (GMT).", + "readonly": true, + "type": "string" + }, + "date_reminder": { + "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": [ + "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" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "The image of the note, if any.", + "readonly": true, + "type": "string" + }, + "is_deleted": { + "context": [ + "edit", + "view" + ], + "description": "Registers whether the note is deleted or not", + "readonly": true, + "type": "boolean" + }, + "is_read": { + "context": [ + "edit", + "view" + ], + "description": "Registers whether the note is read or not", + "readonly": true, + "type": "boolean" + }, + "is_snoozable": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not a user can request to be reminded about the note.", + "readonly": true, + "type": "boolean" + }, + "layout": { + "context": [ + "edit", + "view" + ], + "description": "The layout of the note (eg banner, thumbnail, plain).", + "readonly": true, + "type": "string" + }, + "locale": { + "context": [ + "edit", + "view" + ], + "description": "Locale used for the note title and content.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the note.", + "readonly": true, + "type": "string" + }, + "source": { + "context": [ + "edit", + "view" + ], + "description": "Source of the note.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "The status of the note (e.g. unactioned, actioned).", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Title of the note.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The type of the note (eg error, warning, etc).", + "readonly": true, + "type": "string" + } + }, + "title": "note", + "type": "object" + }, + "onboarding_profile": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "business_extensions": { + "context": [ + "view" + ], + "description": "Extra business extensions to install.", + "readonly": true, + "type": "array" + }, + "completed": { + "context": [ + "view" + ], + "description": "Whether or not the profile was completed.", + "readonly": true, + "type": "boolean" + }, + "industry": { + "context": [ + "view" + ], + "description": "Industry.", + "readonly": true, + "type": "array" + }, + "is_agree_marketing": { + "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" + ], + "description": "Whether or not plugins step in core profiler was skipped.", + "readonly": true, + "type": "boolean" + }, + "is_store_country_set": { + "context": [ + "view" + ], + "description": "Whether or not this store country is set via onboarding profiler.", + "readonly": true, + "type": "boolean" + }, + "number_employees": { + "context": [ + "view" + ], + "description": "Number of employees of the store.", + "enum": [ + "+250", + "<10", + "1", + "10-50", + "50-250", + "not specified" + ], + "readonly": true, + "type": "string" + }, + "other_platform": { + "context": [ + "view" + ], + "description": "Name of other platform used to sell.", + "enum": [ + "amazon", + "bigcommerce", + "ebay", + "etsy", + "magento", + "other", + "shopify", + "squarespace", + "wix" + ], + "readonly": true, + "type": "string" + }, + "other_platform_name": { + "context": [ + "view" + ], + "description": "Name of other platform used to sell (not listed).", + "readonly": true, + "type": "string" + }, + "product_count": { + "context": [ + "view" + ], + "description": "Number of products to be added.", + "enum": [ + "0", + "1-10", + "1000+", + "101-1000", + "11-100" + ], + "readonly": true, + "type": "string" + }, + "product_types": { + "context": [ + "view" + ], + "description": "Types of products sold.", + "readonly": true, + "type": "array" + }, + "revenue": { + "context": [ + "view" + ], + "description": "Current annual revenue of the store.", + "enum": [ + "10000-50000", + "2500-10000", + "50000-250000", + "more-than-250000", + "none", + "rather-not-say", + "up-to-2500" + ], + "readonly": true, + "type": "string" + }, + "selling_venues": { + "context": [ + "view" + ], + "description": "Other places the store is selling products.", + "enum": [ + "brick-mortar", + "brick-mortar-other", + "no", + "other", + "other-woocommerce" + ], + "readonly": true, + "type": "string" + }, + "setup_client": { + "context": [ + "view" + ], + "description": "Whether or not this store was setup for a client.", + "readonly": true, + "type": "boolean" + }, + "skipped": { + "context": [ + "view" + ], + "description": "Whether or not the profile was skipped.", + "readonly": true, + "type": "boolean" + }, + "store_email": { + "context": [ + "view" + ], + "description": "Store email address.", + "readonly": true, + "type": "string" + }, + "theme": { + "context": [ + "view" + ], + "description": "Selected store theme.", + "readonly": true, + "type": "string" + }, + "wccom_connected": { + "context": [ + "view" + ], + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "readonly": true, + "type": "boolean" + } + }, + "title": "onboarding_profile", + "type": "object" + }, + "onboarding_theme": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "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" + }, + "options": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "options": { + "context": [ + "view" + ], + "description": "Array of options with associated values.", + "readonly": true, + "type": "array" + } + }, + "title": "options", + "type": "object" + }, + "order": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set billing address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "List of applied basket coupons.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount applied by this coupon.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount applied by this coupon.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "errors": { + "context": [ + "edit", + "view" + ], + "description": "List of basket item errors, for example, items in the basket which are out of stock.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Error code", + "readonly": true, + "type": "string" + }, + "message": { + "context": [ + "edit", + "view" + ], + "description": "Error message", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID.", + "readonly": true, + "type": "integer" + }, + "items": { + "context": [ + "edit", + "view" + ], + "description": "Line items data.", + "items": { + "properties": { + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "True if backorders are allowed past stock availability.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "catalog_visibility": { + "context": [ + "edit", + "view" + ], + "description": "Whether the product is visible in the catalogue", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The item product or variation ID.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "readonly": true, + "type": "string" + }, + "sizes": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "readonly": true, + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "readonly": true, + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "item_data": { + "context": [ + "edit", + "view" + ], + "description": "Metadata related to the item", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Optionally, how the metadata value should be displayed to the user.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the metadata.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Value of the metadata.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item.", + "readonly": true, + "type": "string" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "prices": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "raw_prices": { + "context": [ + "edit", + "view" + ], + "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", + "properties": { + "precision": { + "context": [ + "edit", + "view" + ], + "description": "Decimal precision of the returned prices.", + "readonly": true, + "type": "integer" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of this item.", + "readonly": true, + "type": "number" + }, + "quantity_limits": { + "context": [ + "edit", + "view" + ], + "description": "How the quantity of this item should be controlled, for example, any limits in place.", + "properties": { + "editable": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "If the quantity is editable or fixed.", + "readonly": true, + "type": "boolean" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "show_backorder_badge": { + "context": [ + "edit", + "view" + ], + "description": "True if the product is on backorder.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Stock keeping unit, if applicable.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "Item total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "line_subtotal": { + "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": [ + "edit", + "view" + ], + "description": "Line subtotal tax.", + "readonly": true, + "type": "string" + }, + "line_total": { + "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": [ + "edit", + "view" + ], + "description": "Line total tax.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "needs_payment": { + "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": [ + "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": [ + "edit", + "view" + ], + "description": "List of required payment gateway features to process the order.", + "readonly": true, + "type": "array" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set shipping address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Status of the order.", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Order totals.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Subtotal of the order.", + "readonly": true, + "type": "string" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Lines of taxes applied to items and shipping.", + "items": { + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "The name of the tax.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "The amount of tax charged.", + "readonly": true, + "type": "string" + }, + "rate": { + "context": [ + "edit", + "view" + ], + "description": "The rate at which tax is applied.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_fees": { + "context": [ + "edit", + "view" + ], + "description": "Total price of any applied fees.", + "readonly": true, + "type": "string" + }, + "total_fees_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on fees.", + "readonly": true, + "type": "string" + }, + "total_items": { + "context": [ + "edit", + "view" + ], + "description": "Total price of items in the order.", + "readonly": true, + "type": "string" + }, + "total_items_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on items in the order.", + "readonly": true, + "type": "string" + }, + "total_price": { + "context": [ + "edit", + "view" + ], + "description": "Total price the customer will pay.", + "readonly": true, + "type": "string" + }, + "total_refund": { + "context": [ + "edit", + "view" + ], + "description": "Total refund applied to the order.", + "readonly": true, + "type": "string" + }, + "total_shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total price of shipping.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax applied to the order.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "order", + "type": "object" }, "order_note": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "order_note", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "The date the order note was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the order note was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "note": { "description": "Order note content.", "type": "string", "context": ["view", "edit"] }, "customer_note": { - "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", + "context": [ + "edit", + "view" + ], "default": false, - "context": ["view", "edit"] - } - } - }, - "shop_order_refund": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shop_order_refund", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true + "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": { - "description": "The date the order refund was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "The date the order note was created, in the site's timezone.", + "readonly": true, + "type": "date-time" }, "date_created_gmt": { - "description": "The date the order refund was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "The date the order note was created, as GMT.", + "readonly": true, + "type": "date-time" }, - "amount": { "description": "Refund amount.", "type": "string", "context": ["view", "edit"] }, - "reason": { "description": "Reason for refund.", "type": "string", "context": ["view", "edit"] }, - "refunded_by": { - "description": "User ID of user who created the refund.", - "type": "integer", - "context": ["view", "edit"] + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, - "refunded_payment": { - "description": "If the payment was refunded via the API.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "note": { + "context": [ + "edit", + "view" + ], + "description": "Order note content.", + "type": "string" + } + }, + "title": "order_note", + "type": "object" + }, + "page": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + }, + "title": "The current user can change the author on this post." + } + ], + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the post.", + "type": "integer" + }, + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "comment_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "menu_order": { + "context": [ + "edit", + "view" + ], + "description": "The order of the post in relation to other posts.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "ping_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "page", + "type": "object" + }, + "page-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "page-revision", + "type": "object" + }, + "pattern-directory-item": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "block_types": { + "context": [ + "embed", + "view" + ], + "description": "The block types which can use this pattern.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "categories": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern's category slugs.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern content.", + "minLength": 1, + "type": "string" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "A description of the pattern.", + "minLength": 1, + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern ID.", + "minimum": 1, + "type": "integer" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern's keywords.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern title, in human readable format.", + "minLength": 1, + "type": "string" + }, + "viewport_width": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The preferred width of the viewport when previewing a pattern, in pixels.", + "type": "integer" + } + }, + "title": "pattern-directory-item", + "type": "object" + }, + "patterns": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "patterns", + "type": "object" + }, + "payment-gateway-suggestions": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "content": { + "context": [ + "edit", + "view" + ], + "description": "Suggestion description.", + "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": [ + "edit", + "view" + ], + "description": "Suggestion visibility.", + "readonly": true, + "type": "boolean" + }, + "plugins": { + "context": [ + "edit", + "view" + ], + "description": "Array of plugin slugs.", + "readonly": true, + "type": "array" + }, + "recommendation_priority": { + "context": [ + "edit", + "view" + ], + "description": "Priority of recommendation.", + "readonly": true, + "type": "integer" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Gateway title.", + "readonly": true, + "type": "string" + }, + "transaction_processors": { + "addtionalProperties": { + "format": "uri", + "type": "string" + }, + "context": [ + "edit", + "view" + ], + "description": "Array of transaction processors and their images.", + "readonly": true, + "type": "object" + } + }, + "title": "payment-gateway-suggestions", + "type": "object" + }, + "payment_gateway": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway ID.", + "readonly": true, + "type": "string" + }, + "method_description": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway method description.", + "readonly": true, + "type": "string" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway method title.", + "readonly": true, + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway title on checkout.", + "type": "string" + } + }, + "title": "payment_gateway", + "type": "object" + }, + "plugin": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "view" + ], + "description": "The plugin author.", + "readonly": true, + "type": "object" + }, + "author_uri": { + "context": [ + "edit", + "view" + ], + "description": "The plugin author's website address.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "description": { + "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" + } + }, + "readonly": true, + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The plugin name.", + "readonly": true, + "type": "string" + }, + "network_only": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the plugin can only be activated network wide.", + "readonly": true, + "type": "boolean" + }, + "plugin": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The plugin file.", + "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", + "readonly": true, + "type": "string" + }, + "plugin_uri": { + "context": [ + "edit", + "view" + ], + "description": "The plugin's website address.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "requires_php": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Minimum required version of PHP.", + "readonly": true, + "type": "string" + }, + "requires_wp": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Minimum required version of WordPress.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The plugin activation status.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "textdomain": { + "context": [ + "edit", + "view" + ], + "description": "The plugin's text domain.", + "readonly": true, + "type": "string" + }, + "version": { + "context": [ + "edit", + "view" + ], + "description": "The plugin version number.", + "readonly": true, + "type": "string" + } + }, + "title": "plugin", + "type": "object" + }, + "plugins": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "connectAction": { + "context": [ + "edit", + "view" + ], + "description": "Action that should be completed to connect Jetpack.", + "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" + }, + "post": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the category taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the category taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the post_tag taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the post_tag taxonomy." + } + ], + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the post.", + "type": "integer" + }, + "categories": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the category taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "comment_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "context": [ + "edit", + "view" + ], + "description": "The format for the post.", + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], + "type": "string" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "ping_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "sticky": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post should be treated as sticky.", + "type": "boolean" + }, + "tags": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the post_tag taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "post", + "type": "object" + }, + "post-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "post-revision", + "type": "object" + }, + "product": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the product_cat taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the product_cat taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the product_tag taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the product_tag taxonomy." + } + ], + "properties": { + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "product_cat": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the product_cat taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "product_tag": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the product_tag taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "product", + "type": "object" + }, + "product-category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of objects (posts of any type) assigned to the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Term description.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Category image.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "Parent term ID, if applicable.", + "readonly": true, + "type": "integer" + }, + "permalink": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Category URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "review_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of reviews for products in this category.", + "readonly": true, + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "String based identifier for the term.", + "readonly": true, + "type": "string" + } + }, + "title": "product-category", + "type": "object" + }, + "product-collection-data": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "attribute_counts": { + "context": [ + "edit", + "view" + ], + "description": "Returns number of products within attribute terms.", + "items": { + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of products.", + "readonly": true, + "type": "integer" + }, + "term": { + "context": [ + "edit", + "view" + ], + "description": "Term ID", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "price_range": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "max_price": { + "context": [ + "edit", + "view" + ], + "description": "Maximum price found in collection of products.", + "readonly": true, + "type": "string" + }, + "min_price": { + "context": [ + "edit", + "view" + ], + "description": "Minimum price found in collection of products.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "rating_counts": { + "context": [ + "edit", + "view" + ], + "description": "Returns number of products with each average rating.", + "items": { + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of products.", + "readonly": true, + "type": "integer" + }, + "rating": { + "context": [ + "edit", + "view" + ], + "description": "Average rating", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "stock_status_counts": { + "context": [ + "edit", + "view" + ], + "description": "Returns number of products with each stock status.", + "items": { + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of products.", + "readonly": true, + "type": "integer" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Status", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + } + }, + "title": "product-collection-data", + "type": "object" + }, + "product-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "product-revision", + "type": "object" + }, + "product_attribute": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "has_archives": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "context": [ + "edit", + "view" + ], + "default": "menu_order", + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "default": "select", + "description": "Type of attribute.", + "enum": [ + "select" + ], + "type": "string" + } + }, + "title": "product_attribute", + "type": "object" + }, + "product_attribute_term": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published products for the resource.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the resource.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "menu_order": { + "context": [ + "edit", + "view" + ], + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "title": "product_attribute_term", + "type": "object" + }, + "product_cat": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "product_cat" + ], + "readonly": true, + "type": "string" + } + }, + "title": "product_cat", + "type": "object" + }, + "product_review": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the review was created, in the site's timezone.", + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the review was created, as GMT.", + "type": "date-time" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Reviewer email.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "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": [ + "edit", + "view" + ], + "description": "Shows if the reviewer bought the product or not.", + "readonly": true, + "type": "boolean" + } + }, + "title": "product_review", + "type": "object" + }, + "product_shipping_class": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published products for the resource.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the resource.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Shipping class name.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "title": "product_shipping_class", + "type": "object" + }, + "product_tag": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "product_tag" + ], + "readonly": true, + "type": "string" + } + }, + "title": "product_tag", + "type": "object" + }, + "product_variation": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "attributes": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "backordered": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on back-order.", + "readonly": true, + "type": "boolean" + }, + "backorders": { + "context": [ + "edit", + "view" + ], + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "type": "string" + }, + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "Shows if back-orders are allowed.", + "readonly": true, + "type": "boolean" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "Start date of sale price, in the site's timezone.", + "type": "date-time" + }, + "date_on_sale_from_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Start date of sale price, as GMT.", + "type": "date-time" + }, + "date_on_sale_to": { + "context": [ + "edit", + "view" + ], + "description": "End date of sale price, in the site's timezone.", + "type": "date-time" + }, + "date_on_sale_to_gmt": { + "context": [ + "edit", + "view" + ], + "description": "End date of sale price, as GMT.", + "type": "date-time" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "context": [ + "edit", + "view" + ], + "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" + } + }, + "type": "object" + }, + "download_expiry": { + "context": [ + "edit", + "view" + ], + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "context": [ + "edit", + "view" + ], + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "downloadable": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "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": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "in_stock": { + "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": [ + "edit", + "view" + ], + "default": false, + "description": "Stock management at variation level.", + "type": "mixed" + }, + "menu_order": { + "context": [ + "edit", + "view" + ], + "description": "Menu order, used to custom sort products.", + "type": "integer" }, "meta_data": { + "context": [ + "edit", + "view" + ], "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], "items": { - "type": "object", "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } + "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" }, - "line_items": { - "description": "Line items data.", - "type": "array", - "context": ["view", "edit"], + "on_sale": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on sale.", "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { - "description": "Product name.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - }, - "product_id": { - "description": "Product ID.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Meta value.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - } - } - } + "type": "boolean" }, - "tax_lines": { - "description": "Tax lines data.", - "type": "array", - "context": ["view", "edit"], + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Variation URL.", + "format": "uri", "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "rate_code": { - "description": "Tax rate code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate_id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "Tax rate label.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "compound": { - "description": "Show if is a compound tax rate.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "tax_total": { - "description": "Tax total (not including shipping taxes).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_tax_total": { - "description": "Shipping tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } + "type": "string" }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "method_title": { - "description": "Shipping method name.", - "type": "mixed", - "context": ["view", "edit"] - }, - "method_id": { "description": "Shipping method ID.", "type": "mixed", "context": ["view", "edit"] }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": ["view", "edit"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current variation price.", + "readonly": true, + "type": "string" }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Fee name.", "type": "mixed", "context": ["view", "edit"] }, - "tax_class": { "description": "Tax class of fee.", "type": "string", "context": ["view", "edit"] }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": ["view", "edit"], - "enum": ["taxable", "none"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } + "purchasable": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation can be bought.", + "readonly": true, + "type": "boolean" }, - "api_refund": { - "description": "When true, the payment gateway API is used to generate the refund.", - "type": "boolean", - "context": ["edit"], - "default": true + "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": [ + "edit", + "view" + ], + "description": "Shipping class ID.", + "readonly": true, + "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": [ + "edit", + "view" + ], + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "type": "string" + }, + "virtual": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is virtual.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "context": [ + "edit", + "view" + ], + "description": "Variation weight (kg).", + "type": "string" } - } + }, + "title": "product_variation", + "type": "object" + }, + "rendered-block": { + "$schema": "http:/json-schema.org/schema#", + "properties": { + "rendered": { + "context": [ + "edit" + ], + "description": "The rendered block.", + "required": true, + "type": "string" + } + }, + "title": "rendered-block", + "type": "object" + }, + "report": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "A human-readable description of the resource.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + } + }, + "title": "report", + "type": "object" + }, + "report_categories": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "category_id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID.", + "readonly": true, + "type": "integer" + }, + "extended_info": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + } + }, + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Amount of items sold.", + "readonly": true, + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "products_count": { + "context": [ + "edit", + "view" + ], + "description": "Amount of products.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_categories", + "type": "object" + }, + "report_coupon_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Coupon type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of coupons.", + "readonly": true, + "type": "string" + } + }, + "title": "report_coupon_total", + "type": "object" + }, + "report_coupons": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "readonly": true, + "type": "number" + }, + "coupon_id": { + "context": [ + "edit", + "view" + ], + "description": "Coupon ID.", + "readonly": true, + "type": "integer" + }, + "extended_info": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "readonly": true, + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "Coupon creation date.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Coupon creation date in GMT.", + "readonly": true, + "type": "date-time" + }, + "date_expires": { + "context": [ + "edit", + "view" + ], + "description": "Coupon expiration date.", + "readonly": true, + "type": "date-time" + }, + "date_expires_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Coupon expiration date in GMT.", + "readonly": true, + "type": "date-time" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "Coupon discount type.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "readonly": true, + "type": "string" + } + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_coupons", + "type": "object" + }, + "report_coupons_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_coupons_stats", + "type": "object" + }, + "report_customer_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Customer type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of customers.", + "readonly": true, + "type": "string" + } + }, + "title": "report_customer_total", + "type": "object" + }, + "report_customers": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "avg_order_value": { + "context": [ + "edit", + "view" + ], + "description": "Average order value", + "readonly": true, + "type": "number" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City.", + "readonly": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region.", + "readonly": true, + "type": "string" + }, + "date_last_active": { + "context": [ + "edit", + "view" + ], + "description": "Date last active.", + "readonly": true, + "type": "date-time" + }, + "date_last_active_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date last active GMT.", + "readonly": true, + "type": "date-time" + }, + "date_registered": { + "context": [ + "edit", + "view" + ], + "description": "Date registered.", + "readonly": true, + "type": "date-time" + }, + "date_registered_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date registered GMT.", + "readonly": true, + "type": "date-time" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name.", + "readonly": true, + "type": "string" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Order count.", + "readonly": true, + "type": "integer" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "readonly": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "Region.", + "readonly": true, + "type": "string" + }, + "total_spend": { + "context": [ + "edit", + "view" + ], + "description": "Total spend.", + "readonly": true, + "type": "number" + }, + "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" + }, + "report_customers_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "avg_avg_order_value": { + "context": [ + "edit", + "view" + ], + "description": "Average AOV per customer.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "avg_orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Average number of orders.", + "readonly": true, + "type": "integer" + }, + "avg_total_spend": { + "context": [ + "edit", + "view" + ], + "description": "Average total spend per customer.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "customers_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of customers.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_customers_stats", + "type": "object" + }, + "report_downloads": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date": { + "context": [ + "edit", + "view" + ], + "description": "The date of the download, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date of the download, as GMT.", + "readonly": true, + "type": "date-time" + }, + "download_id": { + "context": [ + "edit", + "view" + ], + "description": "Download ID.", + "readonly": true, + "type": "string" + }, + "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": [ + "edit", + "view" + ], + "description": "IP address for the downloader.", + "readonly": true, + "type": "string" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order Number.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, + "user_id": { + "context": [ + "edit", + "view" + ], + "description": "User ID for the downloader.", + "readonly": true, + "type": "integer" + }, + "username": { + "context": [ + "edit", + "view" + ], + "description": "User name of the downloader.", + "readonly": true, + "type": "string" + } + }, + "title": "report_downloads", + "type": "object" + }, + "report_export": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "export_id": { + "context": [ + "edit", + "view" + ], + "description": "Export ID.", + "readonly": true, + "type": "string" + }, + "message": { + "context": [ + "edit", + "view" + ], + "description": "Export status message.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Export status.", + "readonly": true, + "type": "string" + } + }, + "title": "report_export", + "type": "object" + }, + "report_export_status": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "download_url": { + "context": [ + "edit", + "view" + ], + "description": "Export download URL.", + "readonly": true, + "type": "string" + }, + "percent_complete": { + "context": [ + "edit", + "view" + ], + "description": "Percentage complete.", + "readonly": true, + "type": "int" + } + }, + "title": "report_export_status", + "type": "object" + }, + "report_import": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "message": { + "context": [ + "edit", + "view" + ], + "description": "Regenerate data message.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Regeneration status.", + "readonly": true, + "type": "string" + } + }, + "title": "report_import", + "type": "object" + }, + "report_order_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Order status name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of orders.", + "readonly": true, + "type": "string" + } + }, + "title": "report_order_total", + "type": "object" + }, + "report_orders": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "customer_id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID.", + "readonly": true, + "type": "integer" + }, + "customer_type": { + "context": [ + "edit", + "view" + ], + "description": "Returning or new customer.", + "readonly": true, + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "Date the order was created, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date the order was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "extended_info": { + "attribution": { + "context": [ + "edit", + "view" + ], + "description": "Order attribution information.", + "readonly": true, + "type": "object" + }, + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "List of order coupons.", + "readonly": true, + "type": "array" + }, + "customer": { + "context": [ + "edit", + "view" + ], + "description": "Order customer information.", + "readonly": true, + "type": "object" + }, + "products": { + "context": [ + "edit", + "view" + ], + "description": "List of order product IDs, names, quantities.", + "readonly": true, + "type": "array" + } + }, + "net_total": { + "context": [ + "edit", + "view" + ], + "description": "Net total revenue.", + "readonly": true, + "type": "float" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of items sold.", + "readonly": true, + "type": "integer" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order Number.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status.", + "readonly": true, + "type": "string" + }, + "total_formatted": { + "context": [ + "edit", + "view" + ], + "description": "Net total revenue (formatted).", + "readonly": true, + "type": "string" + } + }, + "title": "report_orders", + "type": "object" + }, + "report_orders_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "context": [ + "edit", + "view" + ], + "description": "The date the report end, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_end_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_start": { + "context": [ + "edit", + "view" + ], + "description": "The date the report start, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_start_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "readonly": true, + "type": "date-time" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "download_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of downloads.", + "indicator": true, + "readonly": true, + "title": "Downloads", + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "download_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of downloads.", + "indicator": true, + "readonly": true, + "title": "Downloads", + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_orders_stats", + "type": "object" + }, + "report_performance_indicator": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "chart": { + "context": [ + "edit", + "view" + ], + "description": "The specific chart this stat referrers to.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable label for the stat.", + "readonly": true, + "type": "string" + }, + "stat": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "enum": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "readonly": true, + "type": "string" + } + }, + "title": "report_performance_indicator", + "type": "object" + }, + "report_product_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Product type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of products.", + "readonly": true, + "type": "string" + } + }, + "title": "report_product_total", + "type": "object" + }, + "report_products": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "extended_info": { + "category_ids": { + "context": [ + "edit", + "view" + ], + "description": "Product category IDs.", + "readonly": true, + "type": "array" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Product image.", + "readonly": true, + "type": "string" + }, + "low_stock_amount": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory threshold for low stock.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product link.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory quantity.", + "readonly": true, + "type": "integer" + }, + "stock_status": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory status.", + "readonly": true, + "type": "string" + }, + "variations": { + "context": [ + "edit", + "view" + ], + "description": "Product variations IDs.", + "readonly": true, + "type": "array" + } + }, + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of items sold.", + "readonly": true, + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Total Net sales of all items sold.", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders product appeared in.", + "readonly": true, + "type": "integer" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_products", + "type": "object" + }, + "report_products_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_products_stats", + "type": "object" + }, + "report_revenue_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "products": { + "context": [ + "edit", + "view" + ], + "description": "Products sold.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_revenue_stats", + "type": "object" + }, + "report_review_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Review type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of reviews.", + "readonly": true, + "type": "string" + } + }, + "title": "report_review_total", + "type": "object" + }, + "report_stock": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "manage_stock": { + "context": [ + "edit", + "view" + ], + "description": "Manage stock.", + "readonly": true, + "type": "boolean" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "parent_id": { + "context": [ + "edit", + "view" + ], + "description": "Product parent ID.", + "readonly": true, + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier.", + "readonly": true, + "type": "string" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Stock quantity.", + "readonly": true, + "type": "integer" + }, + "stock_status": { + "context": [ + "edit", + "view" + ], + "description": "Stock status.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "readonly": true, + "type": "string" + } + }, + "title": "report_stock", + "type": "object" + }, + "report_taxes": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region.", + "readonly": true, + "type": "string" + }, + "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": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "priority": { + "context": [ + "edit", + "view" + ], + "description": "Priority.", + "readonly": true, + "type": "integer" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "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": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "readonly": true, + "type": "number" + } + }, + "title": "report_taxes", + "type": "object" + }, + "report_taxes_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_taxes_stats", + "type": "object" + }, + "report_variations_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_variations_stats", + "type": "object" + }, + "report_varitations": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "extended_info": { + "attributes": { + "context": [ + "edit", + "view" + ], + "description": "Product attributes.", + "readonly": true, + "type": "array" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Product image.", + "readonly": true, + "type": "string" + }, + "low_stock_amount": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory threshold for low stock.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product link.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory quantity.", + "readonly": true, + "type": "integer" + }, + "stock_status": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory status.", + "readonly": true, + "type": "string" + } + }, + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of items sold.", + "readonly": true, + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Total Net sales of all items sold.", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders product appeared in.", + "readonly": true, + "type": "integer" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_varitations", + "type": "object" + }, + "sales_report": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "average_sales": { + "context": [ + "view" + ], + "description": "Average net daily sales.", + "readonly": true, + "type": "string" + }, + "net_sales": { + "context": [ + "view" + ], + "description": "Net sales in the period.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "view" + ], + "description": "Total of coupons used.", + "readonly": true, + "type": "integer" + }, + "total_items": { + "context": [ + "view" + ], + "description": "Total of items purchased.", + "readonly": true, + "type": "integer" + }, + "total_orders": { + "context": [ + "view" + ], + "description": "Total of orders placed.", + "readonly": true, + "type": "integer" + }, + "total_refunds": { + "context": [ + "view" + ], + "description": "Total of refunded orders.", + "readonly": true, + "type": "integer" + }, + "total_sales": { + "context": [ + "view" + ], + "description": "Gross sales in the period.", + "readonly": true, + "type": "string" + }, + "total_shipping": { + "context": [ + "view" + ], + "description": "Total charged for shipping.", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "view" + ], + "description": "Total charged for taxes.", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "view" + ], + "description": "Totals.", + "items": { + "type": "array" + }, + "readonly": true, + "type": "array" + }, + "totals_grouped_by": { + "context": [ + "view" + ], + "description": "Group type.", + "readonly": true, + "type": "string" + } + }, + "title": "sales_report", + "type": "object" + }, + "search-result": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "embed", + "view" + ], + "description": "Unique identifier for the object.", + "readonly": true, + "type": [ + "integer", + "string" + ] + }, + "subtype": { + "context": [ + "embed", + "view" + ], + "description": "Object subtype.", + "enum": [ + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], + "readonly": true, + "type": "string" + }, + "title": { + "context": [ + "embed", + "view" + ], + "description": "The title for the object.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "embed", + "view" + ], + "description": "Object type.", + "enum": [ + "post", + "post-format", + "term" + ], + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "embed", + "view" + ], + "description": "URL to the object.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "title": "search-result", + "type": "object" + }, + "setting": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "mixed" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "options": { + "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": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea", + "thumbnail_cropping" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "mixed" + } + }, + "title": "setting", + "type": "object" + }, + "setting_group": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "A unique identifier that can be used to link settings together.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "parent_id": { + "context": [ + "view" + ], + "description": "ID of parent grouping.", + "readonly": true, + "type": "string" + }, + "sub_groups": { + "context": [ + "view" + ], + "description": "IDs for settings sub groups.", + "readonly": true, + "type": "string" + } + }, + "title": "setting_group", + "type": "object" + }, + "settings": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_format": { + "default": null, + "description": "A date format for all date strings.", + "title": "", + "type": "string" + }, + "default_category": { + "default": null, + "description": "Default post category.", + "title": "", + "type": "integer" + }, + "default_comment_status": { + "default": null, + "description": "Allow people to submit comments on new posts.", + "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": [ + "closed", + "open" + ], + "title": "", + "type": "string" + }, + "default_post_format": { + "default": null, + "description": "Default post format.", + "title": "", + "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.", + "format": "email", + "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", + "title": "", + "type": "integer" + }, + "page_on_front": { + "default": null, + "description": "The ID of the page that should be displayed on the front page", + "title": "Page on front", + "type": "integer" + }, + "pickup_location_settings": { + "additionalProperties": false, + "default": [], + "description": "WooCommerce Local Pickup Method Settings", + "properties": { + "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": [ + "no", + "yes" + ], + "type": "string" + }, + "tax_status": { + "description": "If a cost is defined, this controls if taxes are applied to that cost.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "title": { + "description": "This controls the title which the user sees during checkout.", + "type": "string" + } + }, + "title": "", + "type": "object" + }, + "pickup_locations": { + "default": [], + "description": "WooCommerce Local Pickup Locations", + "items": { + "additionalProperties": false, + "properties": { + "address": { + "additionalProperties": false, + "properties": { + "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" + } + }, + "type": "object" + }, + "title": "", + "type": "array" + }, + "posts_per_page": { + "default": 10, + "description": "Blog pages show at most.", + "title": "Maximum posts per page", + "type": "integer" + }, + "show_on_front": { + "default": null, + "description": "What to show on the front page", + "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" + }, + "start_of_week": { + "default": null, + "description": "A day number of the week that the week should start on.", + "title": "", + "type": "integer" + }, + "time_format": { + "default": null, + "description": "A time format for all time strings.", + "title": "", + "type": "string" + }, + "timezone": { + "default": null, + "description": "A city in the same timezone as you.", + "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.", + "title": "", + "type": "boolean" + } + }, + "title": "settings", + "type": "object" + }, + "shipping-partner-suggestions": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "items": [ + { + "anyOf": [ + { + "required": "layout_row" + }, + { + "required": "layout_column" + } + ], + "properties": { + "available_layouts": { + "context": [ + "edit", + "view" + ], + "description": "Available layouts -- single, dual, or both", + "items": { + "enum": [ + "column", + "row" + ], + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Description", + "readonly": true, + "type": "string" + }, + "is_visible": { + "context": [ + "edit", + "view" + ], + "description": "Suggestion visibility.", + "readonly": true, + "type": "boolean" + }, + "layout_column": { + "properties": { + "features": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "image": { + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "layout_row": { + "properties": { + "features": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "image": { + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "learn_more_link": { + "context": [ + "edit", + "view" + ], + "description": "Learn more link .", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Plugin name.", + "readonly": true, + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Plugin slug used in https:/wordpress.org/plugins/{slug}.", + "readonly": true, + "type": "string" + } + }, + "required": [ + "available_layouts", + "is_visible", + "name" + ], + "type": "object" + } + ], + "title": "shipping-partner-suggestions", + "type": "array" + }, + "shipping_method": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "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" + } + }, + "title": "shipping_method", + "type": "object" + }, + "shipping_zone": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "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" + }, + "shipping_zone_location": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "default": "country", + "description": "Shipping zone location type.", + "enum": [ + "continent", + "country", + "postcode", + "state" + ], + "type": "string" + } + }, + "title": "shipping_zone_location", + "type": "object" + }, + "shipping_zone_method": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "enabled": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method instance ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method instance ID.", + "readonly": true, + "type": "integer" + }, + "method_description": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method description.", + "readonly": true, + "type": "string" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "readonly": true, + "type": "string" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method title.", + "readonly": true, + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method customer facing title.", + "readonly": true, + "type": "string" + } + }, + "title": "shipping_zone_method", + "type": "object" + }, + "shop_coupon": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_expires": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon expires, in the site's timezone.", + "type": "date-time" + }, + "date_expires_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon expires, as GMT.", + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the coupon was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "default": "fixed_cart", + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "type": "string" + }, + "email_restrictions": { + "context": [ + "edit", + "view" + ], + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "type": "array" + }, + "exclude_sale_items": { + "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": [ + "edit", + "view" + ], + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "excluded_product_ids": { + "context": [ + "edit", + "view" + ], + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "free_shipping": { + "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": [ + "edit", + "view" + ], + "description": "Unique identifier for the object.", + "readonly": true, + "type": "integer" + }, + "individual_use": { + "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": [ + "edit", + "view" + ], + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "context": [ + "edit", + "view" + ], + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "minimum_amount": { + "context": [ + "edit", + "view" + ], + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "context": [ + "edit", + "view" + ], + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "product_ids": { + "context": [ + "edit", + "view" + ], + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of times the coupon has been used already.", + "readonly": true, + "type": "integer" + }, + "usage_limit": { + "context": [ + "edit", + "view" + ], + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "context": [ + "edit", + "view" + ], + "description": "How many times the coupon can be used per customer.", + "type": "integer" + }, + "used_by": { + "context": [ + "edit", + "view" + ], + "description": "List of user IDs (or guest email addresses) that have used the coupon.", + "items": { + "type": "integer" + }, + "readonly": true, + "type": "array" + } + }, + "title": "shop_coupon", + "type": "object" }, "shop_order": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shop_order", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "parent_id": { "description": "Parent order ID.", "type": "integer", "context": ["view", "edit"] }, - "number": { "description": "Order number.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "order_key": { "description": "Order key.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "created_via": { - "description": "Shows where the order was created.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "version": { - "description": "Version of WooCommerce which last updated the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Order status.", - "type": "string", - "default": "pending", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "billing": { + "context": [ + "edit", + "view" ], - "context": ["view", "edit"] + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "type": "object" + }, + "cart_hash": { + "context": [ + "edit", + "view" + ], + "description": "MD5 hash of basket items to ensure orders are not modified.", + "readonly": true, + "type": "string" + }, + "cart_tax": { + "context": [ + "edit", + "view" + ], + "description": "Sum of line item taxes only.", + "readonly": true, + "type": "string" + }, + "coupon_lines": { + "context": [ + "edit", + "view" + ], + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "mixed" + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "created_via": { + "context": [ + "edit", + "view" + ], + "description": "Shows where the order was created.", + "readonly": true, + "type": "string" }, "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", + "context": [ + "edit", + "view" + ], "default": "EUR", + "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", @@ -921,8 +18618,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -1061,12589 +18758,3113 @@ "ZAR", "ZMW" ], - "context": ["view", "edit"] - }, - "date_created": { - "description": "The date the order was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the order was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the order was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the order was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "discount_total": { - "description": "Total discount amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_tax": { - "description": "Total discount tax amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_total": { - "description": "Total shipping amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_tax": { - "description": "Total shipping tax amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "cart_tax": { - "description": "Sum of line item taxes only.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { "description": "Grand total.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "total_tax": { - "description": "Sum of all taxes.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "prices_include_tax": { - "description": "True the prices included tax during checkout.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "default": 0, - "context": ["view", "edit"] - }, - "customer_ip_address": { - "description": "Customer's IP address.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_user_agent": { - "description": "User agent of the customer.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "billing": { - "description": "Billing address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"] - }, - "email": { - "description": "Email address.", - "type": ["string", "null"], - "format": "email", - "context": ["view", "edit"] - }, - "phone": { "description": "Phone number.", "type": "string", "context": ["view", "edit"] } - } - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"] - } - } - }, - "payment_method": { "description": "Payment method ID.", "type": "string", "context": ["view", "edit"] }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "context": ["view", "edit"] - }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string", "context": ["view", "edit"] }, - "date_paid": { - "description": "The date the order was paid, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_paid_gmt": { - "description": "The date the order was paid, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_completed": { - "description": "The date the order was completed, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_completed_gmt": { - "description": "The date the order was completed, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "cart_hash": { - "description": "MD5 hash of basket items to ensure orders are not modified.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Product name.", "type": "mixed", "context": ["view", "edit"] }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": ["view", "edit"] - }, - "product_id": { "description": "Product ID.", "type": "mixed", "context": ["view", "edit"] }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": ["view", "edit"] - }, - "quantity": { "description": "Quantity ordered.", "type": "integer", "context": ["view", "edit"] }, - "tax_class": { "description": "Tax class of product.", "type": "string", "context": ["view", "edit"] }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Tax rate ID", "type": "integer", "context": ["view", "edit"] }, - "total": { "description": "Tax total.", "type": "string", "context": ["view", "edit"] }, - "subtotal": { "description": "Tax subtotal.", "type": "string", "context": ["view", "edit"] } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": ["view", "edit"] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": ["view", "edit"] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - } - } - } - } - } - }, - "tax_lines": { - "description": "Tax lines data.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "rate_code": { - "description": "Tax rate code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate_id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "Tax rate label.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "compound": { - "description": "Show if is a compound tax rate.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "tax_total": { - "description": "Tax total (not including shipping taxes).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_tax_total": { - "description": "Shipping tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "method_title": { - "description": "Shipping method name.", - "type": "mixed", - "context": ["view", "edit"] - }, - "method_id": { "description": "Shipping method ID.", "type": "mixed", "context": ["view", "edit"] }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": ["view", "edit"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Fee name.", "type": "mixed", "context": ["view", "edit"] }, - "tax_class": { "description": "Tax class of fee.", "type": "string", "context": ["view", "edit"] }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": ["view", "edit"], - "enum": ["taxable", "none"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "code": { "description": "Coupon code.", "type": "mixed", "context": ["view", "edit"] }, - "discount": { "description": "Discount total.", "type": "string", "context": ["view", "edit"] }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": ["view"], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "refunds": { - "description": "List of refunds.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Refund ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "reason": { - "description": "Refund reason.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Refund total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "payment_url": { - "description": "Order payment URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "default": false, - "context": ["edit"] - }, - "is_editable": { - "description": "Whether an order can be edited.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_payment": { - "description": "Whether an order needs payment, based on status and order total.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_processing": { - "description": "Whether an order needs processing before it can be completed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_attribute_term": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_attribute_term", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Term name.", "type": "string", "context": ["view", "edit"] }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "context": ["view", "edit"] - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "context": ["view", "edit"] - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "context": ["view", "edit"] - }, - "count": { - "description": "Number of published products for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_attribute": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_attribute", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Attribute name.", "type": "string", "context": ["view", "edit"] }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "context": ["view", "edit"] - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "default": "select", - "enum": ["select"], - "context": ["view", "edit"] - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "default": "menu_order", - "enum": ["menu_order", "name", "name_num", "id"], - "context": ["view", "edit"] - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - } - } - }, - "product_cat": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_cat", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["product_cat"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "parent": { "description": "The parent term ID.", "type": "integer", "context": ["view", "edit"] }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "product_review": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_review", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "review": { "description": "The content of the review.", "type": "string", "context": ["view", "edit"] }, - "date_created": { - "description": "The date the review was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_created_gmt": { - "description": "The date the review was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer", "context": ["view", "edit"] }, - "name": { "description": "Reviewer name.", "type": "string", "context": ["view", "edit"] }, - "email": { "description": "Reviewer email.", "type": "string", "context": ["view", "edit"] }, - "verified": { - "description": "Shows if the reviewer bought the product or not.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_shipping_class": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_shipping_class", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Shipping class name.", "type": "string", "context": ["view", "edit"] }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "context": ["view", "edit"] - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "context": ["view", "edit"] - }, - "count": { - "description": "Number of published products for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_tag": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_tag", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["product_tag"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "product": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "product_cat": { - "description": "The terms assigned to the object in the product_cat taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "product_tag": { - "description": "The terms assigned to the object in the product_tag taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-product_cat", - "title": "The current user can assign terms in the product_cat taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_cat": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-product_cat", - "title": "The current user can create terms in the product_cat taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_cat": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-assign-product_tag", - "title": "The current user can assign terms in the product_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_tag": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-product_tag", - "title": "The current user can create terms in the product_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_tag": { "type": "array", "items": { "type": "integer" } } } - } - } - ] - }, - "product_variation": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_variation", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "The date the variation was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the variation was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "description": { "description": "Variation description.", "type": "string", "context": ["view", "edit"] }, - "permalink": { - "description": "Variation URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { "description": "Unique identifier.", "type": "string", "context": ["view", "edit"] }, - "price": { - "description": "Current variation price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { "description": "Variation regular price.", "type": "string", "context": ["view", "edit"] }, - "sale_price": { "description": "Variation sale price.", "type": "string", "context": ["view", "edit"] }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "on_sale": { - "description": "Shows if the variation is on sale.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "visible": { - "description": "Define if the variation is visible on the product's page.", - "type": "boolean", - "default": true, - "context": ["view", "edit"] - }, - "purchasable": { - "description": "Shows if the variation can be bought.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "File ID.", "type": "string", "context": ["view", "edit"] }, - "name": { "description": "File name.", "type": "string", "context": ["view", "edit"] }, - "file": { "description": "File URL.", "type": "string", "context": ["view", "edit"] } - } - } - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "default": -1, - "context": ["view", "edit"] - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "default": -1, - "context": ["view", "edit"] - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "default": "taxable", - "enum": ["taxable", "shipping", "none"], - "context": ["view", "edit"] - }, - "tax_class": { "description": "Tax class.", "type": "string", "context": ["view", "edit"] }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "mixed", - "default": false, - "context": ["view", "edit"] - }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer", "context": ["view", "edit"] }, - "in_stock": { - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "default": true, - "context": ["view", "edit"] - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "default": "no", - "enum": ["no", "notify", "yes"], - "context": ["view", "edit"] - }, - "backorders_allowed": { - "description": "Shows if back-orders are allowed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "backordered": { - "description": "Shows if the variation is on back-order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "weight": { "description": "Variation weight (kg).", "type": "string", "context": ["view", "edit"] }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "length": { "description": "Variation length (cm).", "type": "string", "context": ["view", "edit"] }, - "width": { "description": "Variation width (cm).", "type": "string", "context": ["view", "edit"] }, - "height": { "description": "Variation height (cm).", "type": "string", "context": ["view", "edit"] } - } - }, - "shipping_class": { "description": "Shipping class slug.", "type": "string", "context": ["view", "edit"] }, - "shipping_class_id": { - "description": "Shipping class ID.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "Variation image data.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": ["view", "edit"] }, - "name": { "description": "Image name.", "type": "string", "context": ["view", "edit"] }, - "alt": { "description": "Image alternative text.", "type": "string", "context": ["view", "edit"] }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": ["view", "edit"] - } - } - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Attribute ID.", "type": "integer", "context": ["view", "edit"] }, - "name": { "description": "Attribute name.", "type": "string", "context": ["view", "edit"] }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": ["view", "edit"] - } - } - } - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "context": ["view", "edit"] - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - }, - "sales_report": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "sales_report", - "type": "object", - "properties": { - "total_sales": { - "description": "Gross sales in the period.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "net_sales": { - "description": "Net sales in the period.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "average_sales": { - "description": "Average net daily sales.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "total_orders": { - "description": "Total of orders placed.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "total_items": { - "description": "Total of items purchased.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "total_tax": { - "description": "Total charged for taxes.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "total_shipping": { - "description": "Total charged for shipping.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "total_refunds": { - "description": "Total of refunded orders.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "total_discount": { - "description": "Total of coupons used.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "totals_grouped_by": { - "description": "Group type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "totals": { - "description": "Totals.", - "type": "array", - "items": { "type": "array" }, - "context": ["view"], - "readonly": true - } - } - }, - "top_sellers_report": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "top_sellers_report", - "type": "object", - "properties": { - "name": { "description": "Product name.", "type": "string", "context": ["view"], "readonly": true }, - "product_id": { "description": "Product ID.", "type": "integer", "context": ["view"], "readonly": true }, - "quantity": { - "description": "Total number of purchases.", - "type": "integer", - "context": ["view"], - "readonly": true - } - } - }, - "report_order_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_order_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Order status name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of orders.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_product_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_product_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Product type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of products.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_customer_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_customer_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Customer type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of customers.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_coupon_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_coupon_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Coupon type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of coupons.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_review_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_review_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Review type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of reviews.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "A human-readable description of the resource.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "setting_group": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "setting_group", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier that can be used to link settings together.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "parent_id": { - "description": "ID of parent grouping.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "sub_groups": { - "description": "IDs for settings sub groups.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "setting": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "setting", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { "description": "Setting value.", "type": "mixed", "context": ["view", "edit"] }, - "default": { - "description": "Default value for the setting.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": ["view", "edit"], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox", - "thumbnail_cropping" - ], - "readonly": true - }, - "options": { - "description": "Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.", - "type": "object", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "shipping_zone": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_zone", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Shipping zone name.", "type": "string", "context": ["view", "edit"] }, - "order": { "description": "Shipping zone order.", "type": "integer", "context": ["view", "edit"] } - } - }, - "shipping_zone_location": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_zone_location", - "type": "object", - "properties": { - "code": { "description": "Shipping zone location code.", "type": "string", "context": ["view", "edit"] }, - "type": { - "description": "Shipping zone location type.", - "type": "string", - "default": "country", - "enum": ["postcode", "state", "country", "continent"], - "context": ["view", "edit"] - } - } - }, - "shipping_zone_method": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_zone_method", - "type": "object", - "properties": { - "id": { - "description": "Shipping method instance ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "instance_id": { - "description": "Shipping method instance ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "title": { - "description": "Shipping method customer facing title.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order": { "description": "Shipping method sort order.", "type": "integer", "context": ["view", "edit"] }, - "enabled": { - "description": "Shipping method enabled status.", - "type": "boolean", - "context": ["view", "edit"] - }, - "method_id": { - "description": "Shipping method ID.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_title": { - "description": "Shipping method title.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_description": { - "description": "Shipping method description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "settings": { - "description": "Shipping method settings.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": ["view", "edit"], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { "description": "Setting value.", "type": "string", "context": ["view", "edit"] }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "tax_class": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "tax_class", - "type": "object", - "properties": { - "slug": { - "description": "Unique identifier for the resource.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Tax class name.", "type": "string", "context": ["view", "edit"], "required": true } - } - }, - "tax": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "tax", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "country": { "description": "Country ISO 3166 code.", "type": "string", "context": ["view", "edit"] }, - "state": { "description": "State code.", "type": "string", "context": ["view", "edit"] }, - "postcode": { "description": "Postcode / ZIP.", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "rate": { "description": "Tax rate.", "type": "string", "context": ["view", "edit"] }, - "name": { "description": "Tax rate name.", "type": "string", "context": ["view", "edit"] }, - "priority": { "description": "Tax priority.", "type": "integer", "default": 1, "context": ["view", "edit"] }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "default": true, - "context": ["view", "edit"] - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "context": ["view", "edit"] - }, - "class": { - "description": "Tax class.", - "type": "string", - "default": "standard", - "enum": ["standard", "reduced-rate", "zero-rate"], - "context": ["view", "edit"] - } - } - }, - "webhook": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "webhook", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "A friendly name for the webhook.", "type": "string", "context": ["view", "edit"] }, - "status": { - "description": "Webhook status.", - "type": "string", - "default": "active", - "enum": ["active", "paused", "disabled"], - "context": ["view", "edit"] - }, - "topic": { "description": "Webhook topic.", "type": "string", "context": ["view", "edit"] }, - "resource": { - "description": "Webhook resource.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "event": { "description": "Webhook event.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "hooks": { - "description": "WooCommerce action names associated with the webhook.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "delivery_url": { - "description": "The URL where the webhook payload is delivered.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "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", - "context": ["edit"] - }, - "date_created": { - "description": "The date the webhook was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the webhook was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the webhook was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the webhook was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "system_status": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "system_status", - "type": "object", - "properties": { - "environment": { - "description": "Environment.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "home_url": { - "description": "Home URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "site_url": { - "description": "Site URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "store_id": { - "description": "WooCommerce Store Identifier.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "version": { - "description": "WooCommerce version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "log_directory": { - "description": "Log directory.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "log_directory_writable": { - "description": "Is log directory writable?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "wp_version": { - "description": "WordPress version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "wp_multisite": { - "description": "Is WordPress multisite?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "wp_memory_limit": { - "description": "WordPress memory limit.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "wp_debug_mode": { - "description": "Is WordPress debug mode active?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "wp_cron": { - "description": "Are WordPress cron jobs enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "language": { - "description": "WordPress language.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "server_info": { "description": "Server info.", "type": "string", "context": ["view"], "readonly": true }, - "php_version": { "description": "PHP version.", "type": "string", "context": ["view"], "readonly": true }, - "php_post_max_size": { - "description": "PHP post max size.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "php_max_execution_time": { - "description": "PHP max execution time.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "php_max_input_vars": { - "description": "PHP max input vars.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "curl_version": { - "description": "cURL version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "suhosin_installed": { - "description": "Is SUHOSIN installed?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "max_upload_size": { - "description": "Max upload size.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "mysql_version": { - "description": "MySQL version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "mysql_version_string": { - "description": "MySQL version string.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "default_timezone": { - "description": "Default timezone.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "fsockopen_or_curl_enabled": { - "description": "Is fsockopen/cURL enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "soapclient_enabled": { - "description": "Is SoapClient class enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "domdocument_enabled": { - "description": "Is DomDocument class enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "gzip_enabled": { - "description": "Is GZip enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "mbstring_enabled": { - "description": "Is mbstring enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "remote_post_successful": { - "description": "Remote POST successful?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "remote_post_response": { - "description": "Remote POST response.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "remote_get_successful": { - "description": "Remote GET successful?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "remote_get_response": { - "description": "Remote GET response.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "database": { - "description": "Database.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "wc_database_version": { - "description": "WC database version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "database_prefix": { - "description": "Database prefix.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "maxmind_geoip_database": { - "description": "MaxMind GeoIP database.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "database_tables": { - "description": "Database tables.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - } - } - }, - "active_plugins": { - "description": "Active plugins.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "inactive_plugins": { - "description": "Inactive plugins.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "dropins_mu_plugins": { - "description": "Dropins & MU plugins.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "theme": { - "description": "Theme.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "name": { "description": "Theme name.", "type": "string", "context": ["view"], "readonly": true }, - "version": { "description": "Theme version.", "type": "string", "context": ["view"], "readonly": true }, - "version_latest": { - "description": "Latest version of theme.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "author_url": { - "description": "Theme author URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "is_child_theme": { - "description": "Is this theme a child theme?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "has_woocommerce_support": { - "description": "Does the theme declare WooCommerce support?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "has_woocommerce_file": { - "description": "Does the theme have a woocommerce.php file?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "has_outdated_templates": { - "description": "Does this theme have outdated templates?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "overrides": { - "description": "Template overrides.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "parent_name": { - "description": "Parent theme name.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "parent_version": { - "description": "Parent theme version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "parent_author_url": { - "description": "Parent theme author URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - } - } - }, - "settings": { - "description": "Settings.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "api_enabled": { - "description": "Legacy REST API enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "force_ssl": { "description": "SSL forced?", "type": "boolean", "context": ["view"], "readonly": true }, - "currency": { "description": "Currency.", "type": "string", "context": ["view"], "readonly": true }, - "currency_symbol": { - "description": "Currency symbol.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "currency_position": { - "description": "Currency position.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "thousand_separator": { - "description": "Thousand separator.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "decimal_separator": { - "description": "Decimal separator.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "number_of_decimals": { - "description": "Number of decimals.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "geolocation_enabled": { - "description": "Geolocation enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "taxonomies": { - "description": "Taxonomy terms for product/order statuses.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "product_visibility_terms": { - "description": "Terms in the product visibility taxonomy.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "wccom_connected": { - "description": "Is store connected to WooCommerce.com?", - "type": "string", - "context": ["view"], - "readonly": true - }, - "enforce_approved_download_dirs": { - "description": "Enforce approved download directories?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "HPOS_enabled": { - "description": "Is HPOS enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "order_datastore": { - "description": "Order datastore.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "HPOS_sync_enabled": { - "description": "Is HPOS sync enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - } - } - }, - "security": { - "description": "Security.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "secure_connection": { - "description": "Is the connection to your store secure?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "hide_errors": { - "description": "Hide errors from visitors?", - "type": "boolean", - "context": ["view"], - "readonly": true - } - } - }, - "pages": { - "description": "WooCommerce pages.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "post_type_counts": { - "description": "Total post count.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "logging": { - "description": "Logging.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "logging_enabled": { - "description": "Is logging enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "default_handler": { - "description": "The logging handler class.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "retention_period_days": { - "description": "The number of days log entries are retained.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "level_threshold": { - "description": "Minimum severity level.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "log_directory_size": { - "description": "The size of the log directory.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - } - } - }, - "system_status_tool": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "system_status_tool", - "type": "object", - "properties": { - "id": { "description": "A unique identifier for the tool.", "type": "string", "context": ["view", "edit"] }, - "name": { "description": "Tool name.", "type": "string", "context": ["view", "edit"] }, - "action": { "description": "What running the tool will do.", "type": "string", "context": ["view", "edit"] }, - "description": { "description": "Tool description.", "type": "string", "context": ["view", "edit"] }, - "success": { "description": "Did the tool run successfully?", "type": "boolean", "context": ["edit"] }, - "message": { "description": "Tool return message.", "type": "string", "context": ["edit"] } - } - }, - "shipping_method": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_method", - "type": "object", - "properties": { - "id": { "description": "Method ID.", "type": "string", "context": ["view"], "readonly": true }, - "title": { "description": "Shipping method title.", "type": "string", "context": ["view"], "readonly": true }, - "description": { - "description": "Shipping method description.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "payment_gateway": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "payment_gateway", - "type": "object", - "properties": { - "id": { - "description": "Payment gateway ID.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "title": { - "description": "Payment gateway title on checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "description": { - "description": "Payment gateway description on checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "order": { "description": "Payment gateway sort order.", "type": "integer", "context": ["view", "edit"] }, - "enabled": { - "description": "Payment gateway enabled status.", - "type": "boolean", - "context": ["view", "edit"] - }, - "method_title": { - "description": "Payment gateway method title.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_description": { - "description": "Payment gateway method description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "settings": { - "description": "Payment gateway settings.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": ["view", "edit"], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { "description": "Setting value.", "type": "string", "context": ["view", "edit"] }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "data_index": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_index", - "type": "object", - "properties": { - "slug": { "description": "Data resource ID.", "type": "string", "context": ["view"], "readonly": true }, - "description": { - "description": "Data resource description.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "data_continents": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_continents", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "2 character continent code.", - "context": ["view"], - "readonly": true - }, - "name": { "type": "string", "description": "Full name of continent.", "context": ["view"], "readonly": true }, - "countries": { - "type": "array", - "description": "List of countries on this continent.", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "code": { - "type": "string", - "description": "ISO3166 alpha-2 country code.", - "context": ["view"], - "readonly": true - }, - "currency_code": { - "type": "string", - "description": "Default ISO4127 alpha-3 currency code for the country.", - "context": ["view"], - "readonly": true - }, - "currency_pos": { - "type": "string", - "description": "Currency symbol position for this country.", - "context": ["view"], - "readonly": true - }, - "decimal_sep": { - "type": "string", - "description": "Decimal separator for displayed prices for this country.", - "context": ["view"], - "readonly": true - }, - "dimension_unit": { - "type": "string", - "description": "The unit lengths are defined in for this country.", - "context": ["view"], - "readonly": true - }, - "name": { - "type": "string", - "description": "Full name of country.", - "context": ["view"], - "readonly": true - }, - "num_decimals": { - "type": "integer", - "description": "Number of decimal points shown in displayed prices for this country.", - "context": ["view"], - "readonly": true - }, - "states": { - "type": "array", - "description": "List of states in this country.", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "code": { "type": "string", "description": "State code.", "context": ["view"], "readonly": true }, - "name": { - "type": "string", - "description": "Full name of state.", - "context": ["view"], - "readonly": true - } - } - } - }, - "thousand_sep": { - "type": "string", - "description": "Thousands separator for displayed prices in this country.", - "context": ["view"], - "readonly": true - }, - "weight_unit": { - "type": "string", - "description": "The unit weights are defined in for this country.", - "context": ["view"], - "readonly": true - } - } - } - } - } - }, - "data_countries": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_countries", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "ISO3166 alpha-2 country code.", - "context": ["view"], - "readonly": true - }, - "name": { "type": "string", "description": "Full name of country.", "context": ["view"], "readonly": true }, - "states": { - "type": "array", - "description": "List of states in this country.", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "code": { "type": "string", "description": "State code.", "context": ["view"], "readonly": true }, - "name": { - "type": "string", - "description": "Full name of state.", - "context": ["view"], - "readonly": true - } - } - } - } - } - }, - "data_currencies": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_currencies", - "type": "object", - "properties": { - "code": { "type": "string", "description": "ISO4217 currency code.", "context": ["view"], "readonly": true }, - "name": { "type": "string", "description": "Full name of currency.", "context": ["view"], "readonly": true }, - "symbol": { "type": "string", "description": "Currency symbol.", "context": ["view"], "readonly": true } - } - }, - "marketing_recommendation": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_recommendation", - "type": "object", - "properties": { - "title": { "type": "string", "context": ["view"], "readonly": true }, - "description": { "type": "string", "context": ["view"], "readonly": true }, - "url": { "type": "string", "context": ["view"], "readonly": true }, - "direct_install": { "type": "string", "context": ["view"], "readonly": true }, - "icon": { "type": "string", "context": ["view"], "readonly": true }, - "product": { "type": "string", "context": ["view"], "readonly": true }, - "plugin": { "type": "string", "context": ["view"], "readonly": true }, - "categories": { "type": "array", "context": ["view"], "readonly": true, "items": { "type": "string" } }, - "subcategories": { - "type": "array", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "slug": { "type": "string", "context": ["view"], "readonly": true }, - "name": { "type": "string", "context": ["view"], "readonly": true } - } - } - }, - "tags": { - "type": "array", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "slug": { "type": "string", "context": ["view"], "readonly": true }, - "name": { "type": "string", "context": ["view"], "readonly": true } - } - } - } - } - }, - "marketing_channel": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_channel", - "type": "object", - "properties": { - "slug": { - "description": "Unique identifier string for the marketing channel extension, also known as the plugin slug.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { - "description": "Name of the marketing channel.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "Description of the marketing channel.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "icon": { - "description": "Path to the channel icon.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "is_setup_completed": { - "type": "boolean", - "description": "Whether or not the marketing channel is set up.", - "context": ["view"], - "readonly": true - }, - "settings_url": { - "description": "URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "product_listings_status": { - "description": "Status of the marketing channel's product listings.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "errors_count": { - "description": "Number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "marketing_campaign": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_campaign", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier for the marketing campaign.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "channel": { - "description": "The unique identifier for the marketing channel that this campaign belongs to.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "title": { - "description": "Title of the marketing campaign.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "manage_url": { - "description": "URL to the campaign management page.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "cost": { - "description": "Cost of the marketing campaign.", - "context": ["view"], - "readonly": true, - "type": "object", - "properties": { - "value": { "type": "string", "context": ["view"], "readonly": true }, - "currency": { "type": "string", "context": ["view"], "readonly": true } - } - }, - "sales": { - "description": "Sales of the marketing campaign.", - "context": ["view"], - "readonly": true, - "type": "object", - "properties": { - "value": { "type": "string", "context": ["view"], "readonly": true }, - "currency": { "type": "string", "context": ["view"], "readonly": true } - } - } - } - }, - "marketing_campaign_type": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_campaign_type", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier for the marketing campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { - "description": "Name of the marketing campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "Description of the marketing campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "channel": { - "description": "The marketing channel that this campaign type belongs to.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "slug": { - "description": "The unique identifier of the marketing channel that this campaign type belongs to.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { - "description": "The name of the marketing channel that this campaign type belongs to.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "create_url": { - "description": "URL to the create campaign page for this campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "icon_url": { - "description": "URL to an image/icon for the campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "options": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "options", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of options with associated values.", - "context": ["view"], - "readonly": true - } - } - }, - "payment-gateway-suggestions": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "payment-gateway-suggestions", - "type": "object", - "properties": { - "content": { - "description": "Suggestion description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "id": { "description": "Suggestion ID.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "image": { "description": "Gateway image.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "is_visible": { - "description": "Suggestion visibility.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "plugins": { - "description": "Array of plugin slugs.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "recommendation_priority": { - "description": "Priority of recommendation.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "title": { "description": "Gateway title.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "transaction_processors": { - "description": "Array of transaction processors and their images.", - "type": "object", - "addtionalProperties": { "type": "string", "format": "uri" }, - "context": ["view", "edit"], - "readonly": true - } - } - }, - "upload_theme": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "upload_theme", - "type": "object", - "properties": { - "status": { - "description": "Theme installation status.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Theme installation message.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "theme": { "description": "Uploaded theme.", "type": "object", "context": ["view", "edit"], "readonly": true } - } - }, - "plugins": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "plugins", - "type": "object", - "properties": { - "slug": { "description": "Plugin slug.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Plugin name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "connectAction": { - "description": "Action that should be completed to connect Jetpack.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "onboarding_profile": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "onboarding_profile", - "type": "object", - "properties": { - "completed": { - "type": "boolean", - "description": "Whether or not the profile was completed.", - "context": ["view"], - "readonly": true - }, - "skipped": { - "type": "boolean", - "description": "Whether or not the profile was skipped.", - "context": ["view"], - "readonly": true - }, - "industry": { "type": "array", "description": "Industry.", "context": ["view"], "readonly": true }, - "product_types": { - "type": "array", - "description": "Types of products sold.", - "context": ["view"], - "readonly": true - }, - "product_count": { - "type": "string", - "description": "Number of products to be added.", - "context": ["view"], - "readonly": true, - "enum": ["0", "1-10", "11-100", "101-1000", "1000+"] - }, - "selling_venues": { - "type": "string", - "description": "Other places the store is selling products.", - "context": ["view"], - "readonly": true, - "enum": ["no", "other", "brick-mortar", "brick-mortar-other", "other-woocommerce"] - }, - "number_employees": { - "type": "string", - "description": "Number of employees of the store.", - "context": ["view"], - "readonly": true, - "enum": ["1", "<10", "10-50", "50-250", "+250", "not specified"] - }, - "revenue": { - "type": "string", - "description": "Current annual revenue of the store.", - "context": ["view"], - "readonly": true, - "enum": [ - "none", - "up-to-2500", - "2500-10000", - "10000-50000", - "50000-250000", - "more-than-250000", - "rather-not-say" - ] - }, - "other_platform": { - "type": "string", - "description": "Name of other platform used to sell.", - "context": ["view"], - "readonly": true, - "enum": ["shopify", "bigcommerce", "magento", "wix", "amazon", "ebay", "etsy", "squarespace", "other"] - }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed).", - "context": ["view"], - "readonly": true - }, - "business_extensions": { - "type": "array", - "description": "Extra business extensions to install.", - "context": ["view"], - "readonly": true - }, - "theme": { "type": "string", "description": "Selected store theme.", "context": ["view"], "readonly": true }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client.", - "context": ["view"], - "readonly": true - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", - "context": ["view"], - "readonly": true - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", - "context": ["view"], - "readonly": true - }, - "store_email": { - "type": "string", - "description": "Store email address.", - "context": ["view"], - "readonly": true - }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler.", - "context": ["view"], - "readonly": true - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped.", - "context": ["view"], - "readonly": true - } - } - }, - "onboarding_theme": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "onboarding_theme", - "type": "object", - "properties": { - "slug": { "description": "Theme slug.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Theme name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "status": { "description": "Theme status.", "type": "string", "context": ["view", "edit"], "readonly": true } - } - }, - "Install Async Schema": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "Install Async Schema", - "type": "object", - "properties": { - "type": "object", - "properties": { - "job_id": "integer", - "status": { "type": "string", "enum": ["pending", "complete", "failed"] } - } - } - }, - "Install and Activate Schema": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "Install and Activate Schema", - "type": "object", - "properties": { - "type": "object", - "properties": { - "install": { - "type": "object", - "properties": { - "installed": { "type": "array", "items": { "type": "string" } }, - "results": { "type": "array", "items": { "type": "string" } }, - "errors": { - "type": "object", - "properties": { - "errors": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - }, - "error_data": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - } - } - } - } - }, - "activate": { - "type": "object", - "properties": { - "activated": { "type": "array", "items": { "type": "string" } }, - "active": { "type": "array", "items": { "type": "string" } }, - "errors": { - "type": "object", - "properties": { - "errors": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - }, - "error_data": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - } - } - } - } - } - } - } - }, - "shipping-partner-suggestions": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping-partner-suggestions", - "type": "array", - "items": [ - { - "type": "object", - "required": ["name", "is_visible", "available_layouts"], - "anyOf": [{ "required": "layout_row" }, { "required": "layout_column" }], - "properties": { - "name": { - "description": "Plugin name.", - "type": "string", - "required": true, - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Plugin slug used in https:/wordpress.org/plugins/{slug}.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "layout_row": { - "type": "object", - "properties": { - "image": { "type": "string", "description": "" }, - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - "icon": { "type": "string" }, - "title": { "type": "string" }, - "description": { "type": "string" } - } - } - } - } - }, - "layout_column": { - "type": "object", - "properties": { - "image": { "type": "string", "description": "" }, - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - "icon": { "type": "string" }, - "title": { "type": "string" }, - "description": { "type": "string" } - } - } - } - } - }, - "description": { - "description": "Description", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "learn_more_link": { - "description": "Learn more link .", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "is_visible": { - "description": "Suggestion visibility.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "available_layouts": { - "description": "Available layouts -- single, dual, or both", - "type": "array", - "items": { "type": "string", "enum": ["row", "column"] }, - "context": ["view", "edit"], - "readonly": true - } - } - } - ] - }, - "report_customers": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_customers", - "type": "object", - "properties": { - "id": { "description": "Customer ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "user_id": { "description": "User ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "username": { "description": "Username.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "country": { - "description": "Country/Region.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "city": { "description": "City.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "state": { "description": "Region.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_registered": { - "description": "Date registered.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_registered_gmt": { - "description": "Date registered GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_last_active": { - "description": "Date last active.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_last_active_gmt": { - "description": "Date last active GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Order count.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total_spend": { - "description": "Total spend.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "avg_order_value": { - "description": "Average order value", - "type": "number", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "leaderboard": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "leaderboard", - "type": "object", - "properties": { - "id": { "type": "string", "description": "Leaderboard ID.", "context": ["view"], "readonly": true }, - "label": { - "type": "string", - "description": "Displayed title for the leaderboard.", - "context": ["view"], - "readonly": true - }, - "headers": { - "type": "array", - "description": "Table headers.", - "context": ["view"], - "readonly": true, - "items": { - "type": "array", - "properties": { - "label": { - "description": "Table column header.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "rows": { - "type": "array", - "description": "Table rows.", - "context": ["view"], - "readonly": true, - "items": { - "type": "array", - "properties": { - "display": { - "description": "Table cell display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Table cell value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "format": { - "description": "Table cell format.", - "type": "string", - "context": ["view"], - "enum": ["currency", "number"], - "readonly": true, - "required": false - } - } - } - } - } - }, - "report_import": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_import", - "type": "object", - "properties": { - "status": { - "description": "Regeneration status.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Regenerate data message.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_export": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_export", - "type": "object", - "properties": { - "status": { - "description": "Export status.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Export status message.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "export_id": { "description": "Export ID.", "type": "string", "context": ["view", "edit"], "readonly": true } - } - }, - "report_export_status": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_export_status", - "type": "object", - "properties": { - "percent_complete": { - "description": "Percentage complete.", - "type": "int", - "context": ["view", "edit"], - "readonly": true - }, - "download_url": { - "description": "Export download URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_products": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_products", - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "items_sold": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of items sold." - }, - "net_revenue": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Total Net sales of all items sold." - }, - "orders_count": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of orders product appeared in." - }, - "extended_info": { - "name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Product name." }, - "price": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Product price." - }, - "image": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product image." - }, - "permalink": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product link." - }, - "category_ids": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "Product category IDs." - }, - "stock_status": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory status." - }, - "stock_quantity": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory quantity." - }, - "low_stock_amount": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory threshold for low stock." - }, - "variations": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "Product variations IDs." - }, - "sku": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Product SKU." } - } - } - }, - "report_varitations": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_varitations", - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "variation_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "items_sold": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of items sold." - }, - "net_revenue": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Total Net sales of all items sold." - }, - "orders_count": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of orders product appeared in." - }, - "extended_info": { - "name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Product name." }, - "price": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Product price." - }, - "image": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product image." - }, - "permalink": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product link." - }, - "attributes": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "Product attributes." - }, - "stock_status": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory status." - }, - "stock_quantity": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory quantity." - }, - "low_stock_amount": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory threshold for low stock." - } - } - } - }, - "report_products_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_products_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - } - } - } - } - } - }, - "report_variations_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_variations_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - } - } - } - } - } - }, - "report_revenue_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_revenue_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - } - } - } - } - } - }, - "products": { - "description": "Products sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "report_orders": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_orders", - "type": "object", - "properties": { - "order_id": { "description": "Order ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "order_number": { - "description": "Order Number.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "Date the order was created, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "Date the order was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "status": { "description": "Order status.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "customer_id": { - "description": "Customer ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Number of items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "net_total": { - "description": "Net total revenue.", - "type": "float", - "context": ["view", "edit"], - "readonly": true - }, - "total_formatted": { - "description": "Net total revenue (formatted).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_type": { - "description": "Returning or new customer.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extended_info": { - "products": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "List of order product IDs, names, quantities." - }, - "coupons": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "List of order coupons." - }, - "customer": { - "type": "object", - "readonly": true, - "context": ["view", "edit"], - "description": "Order customer information." - }, - "attribution": { - "type": "object", - "readonly": true, - "context": ["view", "edit"], - "description": "Order attribution information." - } - } - } - }, - "report_orders_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_orders_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "download_count": { - "title": "Downloads", - "description": "Number of downloads.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "download_count": { - "title": "Downloads", - "description": "Number of downloads.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - } - } - } - } - } - }, - "report_categories": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_categories", - "type": "object", - "properties": { - "category_id": { - "description": "Category ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "items_sold": { - "description": "Amount of items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "net_revenue": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "products_count": { - "description": "Amount of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "extended_info": { - "name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Category name." } - } - } - }, - "report_taxes": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_taxes", - "type": "object", - "properties": { - "tax_rate_id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Tax rate name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "tax_rate": { "description": "Tax rate.", "type": "number", "context": ["view", "edit"], "readonly": true }, - "country": { - "description": "Country/Region.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "state": { "description": "State.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "priority": { "description": "Priority.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "total_tax": { "description": "Total tax.", "type": "number", "context": ["view", "edit"], "readonly": true }, - "order_tax": { "description": "Order tax.", "type": "number", "context": ["view", "edit"], "readonly": true }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_taxes_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_taxes_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - } - } - } - } - } - } - } - }, - "report_coupons": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_coupons", - "type": "object", - "properties": { - "coupon_id": { - "description": "Coupon ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "extended_info": { - "code": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Coupon code." }, - "date_created": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon creation date." - }, - "date_created_gmt": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon creation date in GMT." - }, - "date_expires": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon expiration date." - }, - "date_expires_gmt": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon expiration date in GMT." - }, - "discount_type": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "enum": ["percent", "fixed_cart", "fixed_product"], - "description": "Coupon discount type." - } - } - } - }, - "report_coupons_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_coupons_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - } - } - } - } - } - } - } - } - } - } - }, - "report_stock": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_stock", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Product name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "stock_status": { - "description": "Stock status.", - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "context": ["view", "edit"], - "readonly": true - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "manage_stock": { - "description": "Manage stock.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_customers_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_customers_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "customers_count": { - "description": "Number of customers.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "avg_orders_count": { - "description": "Average number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "avg_total_spend": { - "description": "Average total spend per customer.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "avg_avg_order_value": { - "description": "Average AOV per customer.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - } - } - } - } - }, - "report_downloads": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_downloads", - "type": "object", - "properties": { - "id": { "type": "integer", "readonly": true, "context": ["view", "edit"], "description": "ID." }, - "product_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "date": { - "description": "The date of the download, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_gmt": { - "description": "The date of the download, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "download_id": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Download ID." - }, - "file_name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "File name." }, - "file_path": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "File URL." }, - "order_id": { "type": "integer", "readonly": true, "context": ["view", "edit"], "description": "Order ID." }, - "order_number": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Order Number." - }, - "user_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "User ID for the downloader." - }, - "username": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "User name of the downloader." - }, - "ip_address": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "IP address for the downloader." - } - } - }, - "report_performance_indicator": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_performance_indicator", - "type": "object", - "properties": { - "stat": { - "description": "Unique identifier for the resource.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - }, - "chart": { - "description": "The specific chart this stat referrers to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "Human readable label for the stat.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "note": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "note", - "type": "object", - "properties": { - "id": { "description": "ID of the note record.", "type": "integer", "context": ["view"], "readonly": true }, - "name": { - "description": "Name of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "The type of the note (eg error, warning, etc).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "locale": { - "description": "Locale used for the note title and content.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "title": { - "description": "Title of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "content": { - "description": "Content of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "content_data": { - "description": "Content data for the note. JSON string. Available for re-localisation.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "The status of the note (e.g. unactioned, actioned).", - "type": "string", - "context": ["view", "edit"] - }, - "source": { - "description": "Source of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "Date the note was created.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "Date the note was created (GMT).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_reminder": { - "description": "Date after which the user should be reminded of the note, if any.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_reminder_gmt": { - "description": "Date after which the user should be reminded of the note, if any (GMT).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "is_snoozable": { - "description": "Whether or not a user can request to be reminded about the note.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "actions": { - "description": "An array of actions, if any, for the note.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "layout": { - "description": "The layout of the note (eg banner, thumbnail, plain).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "The image of the note, if any.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "is_deleted": { - "description": "Registers whether the note is deleted or not", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_read": { - "description": "Registers whether the note is read or not", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "data_download_ips": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_download_ips", - "type": "object", - "properties": { - "user_ip_address": { "type": "string", "description": "IP address.", "context": ["view"], "readonly": true } - } - }, - "Count Low in Stock Items": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "Count Low in Stock Items", - "type": "object", - "properties": { "type": "object", "properties": { "total": "integer" } } - }, - "cart": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart", - "type": "object", - "properties": { - "coupons": { - "description": "List of applied basket coupons.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "The coupon's unique code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "totals": { - "description": "Total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "shipping_rates": { - "description": "List of available shipping rates for the basket.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "package_id": { - "description": "The ID of the package the shipping rates belong to.", - "type": ["integer", "string"], - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Name of the package.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "destination": { - "description": "Shipping destination address.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "address_1": { - "description": "First line of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "address_2": { - "description": "Second line of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "city": { - "description": "City of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "state": { - "description": "ISO code, or name, for the state, province, or district of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "postcode": { - "description": "Zip or Postcode of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "country": { - "description": "ISO code for the country of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "items": { - "description": "List of basket items the returned shipping rates apply to.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Name of the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of the item in the current package.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "shipping_rates": { - "description": "List of shipping rates.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "rate_id": { - "description": "ID of the shipping rate.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Name of the shipping rate, e.g. Express shipping.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Description of the shipping rate, e.g. Dispatched via Royal Mail.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "delivery_time": { - "description": "Delivery time estimate text, e.g. 3-5 business days.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Price of this shipping rate using the smallest unit of the currency.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Taxes applied to this shipping rate using the smallest unit of the currency.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_id": { - "description": "ID of the shipping method that provided the rate.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "instance_id": { - "description": "Instance ID of the shipping method that provided the rate.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data attached to the shipping rate.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "key": { - "description": "Meta key.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Meta value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "selected": { - "description": "True if this is the rate currently selected by the customer for the basket.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - } - }, - "shipping_address": { - "description": "Current set shipping address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "billing_address": { - "description": "Current set billing address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "email": { - "description": "Email", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "items": { - "description": "List of basket items.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "The item type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "id": { - "description": "The item product or variation ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of this item.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "quantity_limits": { - "description": "How the quantity of this item should be controlled, for example, any limits in place.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "minimum": { - "description": "The minimum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - }, - "editable": { - "description": "If the quantity is editable or fixed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true, - "default": true - } - } - }, - "name": { - "description": "Product name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Stock keeping unit, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "backorders_allowed": { - "description": "True if backorders are allowed past stock availability.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "show_backorder_badge": { - "description": "True if the product is on backorder.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Image name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "item_data": { - "description": "Metadata related to the item", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "Name of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Value of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "display": { - "description": "Optionally, how the metadata value should be displayed to the user.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "prices": { - "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.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "raw_prices": { - "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "precision": { - "description": "Decimal precision of the returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "totals": { - "description": "Item total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal": { - "description": "Line subtotal (the price of the product before coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal_tax": { - "description": "Line subtotal tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total": { - "description": "Line total (the price of the product after coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total_tax": { - "description": "Line total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "catalog_visibility": { - "description": "Whether the product is visible in the catalogue", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [], "readonly": true } - } - } - }, - "items_count": { - "description": "Number of items in the basket.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "items_weight": { - "description": "Total weight (in grams) of all products in the basket.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "cross_sells": { - "description": "List of cross-sells items related to basket items.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Product slug.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "parent": { - "description": "ID of the parent product, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Product type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "variation": { - "description": "Product variation attributes, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "on_sale": { - "description": "Is the product on sale?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "prices": { - "description": "Price data provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "price_html": { - "description": "Price string formatted as HTML.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "average_rating": { - "description": "Reviews average rating.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "review_count": { - "description": "Amount of reviews that the product has.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Image name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "categories": { - "description": "List of categories, if applicable.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Category name", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Category slug", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "link": { - "description": "Category link", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "tags": { - "description": "List of tags, if applicable.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Tag name", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Tag slug", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "link": { - "description": "Tag link", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "attributes": { - "description": "List of attributes (taxonomy terms) assigned to the product. For variable products, these are mapped to variations (see the `variations` field).", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "The attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxonomy": { - "description": "The attribute taxonomy, or null if the attribute is not taxonomy based.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "has_variations": { - "description": "True if this attribute is used by product variations.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "terms": { - "description": "List of assigned attribute terms.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "The term ID, or 0 if the attribute is not a global attribute.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "The term name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "The term slug.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "default": { - "description": "If this is a default attribute", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - } - } - }, - "readonly": true - }, - "variations": { - "description": "List of variation IDs, if applicable.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "attributes": { - "description": "List of variation attributes.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "name": { - "description": "The attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "The assigned attribute.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - } - } - }, - "readonly": true - }, - "has_options": { - "description": "Does the product have additional options before it can be added to the basket?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_purchasable": { - "description": "Is the product purchasable?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_in_stock": { - "description": "Is the product in stock?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_on_backorder": { - "description": "Is the product stock backordered? This will also return false if backorder notifications are turned off.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "add_to_cart": { - "description": "Add to basket button parameters.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "text": { - "description": "Button text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Button description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "url": { - "description": "Add to basket URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "minimum": { - "description": "The minimum quantity that can be added to the basket.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity that can be added to the basket.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - } - } - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [], "readonly": true } - } - } - }, - "needs_payment": { - "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_shipping": { - "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "has_calculated_shipping": { - "description": "True if the basket meets the criteria for showing shipping costs, and rates have been calculated and included in the totals.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "fees": { - "description": "List of basket fees.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the fee within the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Fee name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "totals": { - "description": "Fee total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Total amount for this fee.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Total tax amount for this fee.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "totals": { - "description": "Basket total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items": { - "description": "Total price of items in the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items_tax": { - "description": "Total tax on items in the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_fees": { - "description": "Total price of any applied fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_fees_tax": { - "description": "Total tax on fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping": { - "description": "Total price of shipping. If shipping has not been calculated, a null response will be sent.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping_tax": { - "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "total_price": { - "description": "Total price the customer will pay.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Total tax applied to items and shipping.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "tax_lines": { - "description": "Lines of taxes applied to items and shipping.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "The amount of tax charged.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate": { - "description": "The rate at which tax is applied.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "errors": { - "description": "List of basket item errors, for example, items in the basket which are out of stock.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Error message", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "payment_methods": { - "description": "List of available payment method IDs that can be used to process the order.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "payment_requirements": { - "description": "List of required payment gateway features to process the order.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "cart_coupon": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart_coupon", - "type": "object", - "properties": { - "code": { "description": "The coupon's unique code.", "type": "string", "context": ["view", "edit"] }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "context": ["view", "edit"] - }, - "totals": { - "description": "Total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "cart-extensions": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart-extensions", - "type": "object", - "properties": [] - }, - "cart_item": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart_item", - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { "description": "The item type.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "id": { - "description": "The item product or variation ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of this item.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "quantity_limits": { - "description": "How the quantity of this item should be controlled, for example, any limits in place.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "minimum": { - "description": "The minimum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - }, - "editable": { - "description": "If the quantity is editable or fixed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true, - "default": true - } - } - }, - "name": { "description": "Product name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Stock keeping unit, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "backorders_allowed": { - "description": "True if backorders are allowed past stock availability.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "show_backorder_badge": { - "description": "True if the product is on backorder.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "name": { "description": "Image name.", "type": "string", "context": ["view", "edit"] }, - "alt": { "description": "Image alternative text.", "type": "string", "context": ["view", "edit"] } - } - } - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "item_data": { - "description": "Metadata related to the item", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "Name of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Value of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "display": { - "description": "Optionally, how the metadata value should be displayed to the user.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "prices": { - "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.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "raw_prices": { - "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "precision": { - "description": "Decimal precision of the returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "totals": { - "description": "Item total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal": { - "description": "Line subtotal (the price of the product before coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal_tax": { - "description": "Line subtotal tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total": { - "description": "Line total (the price of the product after coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total_tax": { - "description": "Line total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "catalog_visibility": { - "description": "Whether the product is visible in the catalogue", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "checkout": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "checkout", - "type": "object", - "properties": { - "order_id": { - "description": "The order ID to process during checkout.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Order status. Payment providers will update this value after payment.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_key": { - "description": "Order key used to check validity or protect access to certain order data.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_number": { - "description": "Order number used for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "customer_id": { - "description": "Customer ID if registered. Will return 0 for guests.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true }, - "email": { "description": "Email", "type": "string", "context": ["view", "edit"], "required": true } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true } - } - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "context": ["view", "edit"], - "enum": ["bacs", "cheque", "cod"] - }, - "create_account": { - "description": "Whether to create a new user account as part of order processing.", - "type": "boolean", - "context": ["view", "edit"] - }, - "payment_result": { - "description": "Result of payment processing, or false if not yet processed.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "payment_status": { - "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", - "readonly": true, - "type": "string" - }, - "payment_details": { - "description": "An array of data being returned from the payment gateway.", - "readonly": true, - "type": "array", - "items": { - "type": "object", - "properties": { "key": { "type": "string" }, "value": { "type": "string" } } - } - }, - "redirect_url": { - "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", - "readonly": true, - "type": "string" - } - } - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "context": ["view", "edit"], - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "context": ["view", "edit"], - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": ["object", "null"], - "context": ["view", "edit"], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": ["string", "null"], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": ["string", "null"], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": ["string", "null"], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": ["string", "null"], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": ["string", "null"], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": ["string", "null"], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": ["string", "null"], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": ["string", "null"], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": ["string", "null"], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": ["string", "null"], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": ["string", "null"], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": ["string", "null"], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": ["string", "null"], - "context": [] - } - } - } - } - } - } - }, - "checkout-order": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "checkout-order", - "type": "object", - "properties": { - "order_id": { - "description": "The order ID to process during checkout.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Order status. Payment providers will update this value after payment.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_key": { - "description": "Order key used to check validity or protect access to certain order data.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_number": { - "description": "Order number used for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "customer_id": { - "description": "Customer ID if registered. Will return 0 for guests.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true }, - "email": { "description": "Email", "type": "string", "context": ["view", "edit"], "required": true } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true } - } - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "context": ["view", "edit"], - "enum": ["bacs", "cheque", "cod"] - }, - "payment_result": { - "description": "Result of payment processing, or false if not yet processed.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "payment_status": { - "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", - "readonly": true, - "type": "string" - }, - "payment_details": { - "description": "An array of data being returned from the payment gateway.", - "readonly": true, - "type": "array", - "items": { - "type": "object", - "properties": { "key": { "type": "string" }, "value": { "type": "string" } } - } - }, - "redirect_url": { - "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", - "readonly": true, - "type": "string" - } - } - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "context": ["view", "edit"], - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "context": ["view", "edit"], - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": ["object", "null"], - "context": ["view", "edit"], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": ["string", "null"], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": ["string", "null"], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": ["string", "null"], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": ["string", "null"], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": ["string", "null"], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": ["string", "null"], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": ["string", "null"], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": ["string", "null"], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": ["string", "null"], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": ["string", "null"], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": ["string", "null"], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": ["string", "null"], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": ["string", "null"], - "context": [] - } - } - } - } - } - } - }, - "order": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "order", - "type": "object", - "properties": { - "id": { "description": "The order ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "items": { - "description": "Line items data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "The item type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "id": { - "description": "The item product or variation ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of this item.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "quantity_limits": { - "description": "How the quantity of this item should be controlled, for example, any limits in place.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "minimum": { - "description": "The minimum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - }, - "editable": { - "description": "If the quantity is editable or fixed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true, - "default": true - } - } - }, - "name": { - "description": "Product name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Stock keeping unit, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "backorders_allowed": { - "description": "True if backorders are allowed past stock availability.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "show_backorder_badge": { - "description": "True if the product is on backorder.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Image name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "item_data": { - "description": "Metadata related to the item", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "Name of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Value of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "display": { - "description": "Optionally, how the metadata value should be displayed to the user.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "prices": { - "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.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "raw_prices": { - "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "precision": { - "description": "Decimal precision of the returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "totals": { - "description": "Item total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal": { - "description": "Line subtotal (the price of the product before coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal_tax": { - "description": "Line subtotal tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total": { - "description": "Line total (the price of the product after coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total_tax": { - "description": "Line total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "catalog_visibility": { - "description": "Whether the product is visible in the catalogue", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [], "readonly": true } - } - } - }, - "totals": { - "description": "Order totals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Subtotal of the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping": { - "description": "Total price of shipping.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "total_fees": { - "description": "Total price of any applied fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Total tax applied to the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_refund": { - "description": "Total refund applied to the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_price": { - "description": "Total price the customer will pay.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items": { - "description": "Total price of items in the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items_tax": { - "description": "Total tax on items in the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_fees_tax": { - "description": "Total tax on fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping_tax": { - "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "tax_lines": { - "description": "Lines of taxes applied to items and shipping.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "The amount of tax charged.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate": { - "description": "The rate at which tax is applied.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "coupons": { - "description": "List of applied basket coupons.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "The coupon's unique code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "totals": { - "description": "Total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "shipping_address": { - "description": "Current set shipping address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "billing_address": { - "description": "Current set billing address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "email": { - "description": "Email", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "needs_payment": { - "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_shipping": { - "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "errors": { - "description": "List of basket item errors, for example, items in the basket which are out of stock.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Error message", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "payment_requirements": { - "description": "List of required payment gateway features to process the order.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Status of the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "term": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "term", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Term name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "slug": { - "description": "String based identifier for the term.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Term description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "parent": { - "description": "Parent term ID, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "count": { - "description": "Number of objects (posts of any type) assigned to the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product-category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product-category", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Term name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "slug": { - "description": "String based identifier for the term.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Term description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "parent": { - "description": "Parent term ID, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "count": { - "description": "Number of objects (posts of any type) assigned to the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "Category image.", - "type": "object", - "context": ["view", "edit", "embed"], - "readonly": true, - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "name": { "description": "Image name.", "type": "string", "context": ["view", "edit"] }, - "alt": { "description": "Image alternative text.", "type": "string", "context": ["view", "edit"] } - } - }, - "review_count": { - "description": "Number of reviews for products in this category.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Category URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "product-collection-data": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product-collection-data", - "type": "object", - "properties": { - "price_range": { - "description": "Min and max prices found in collection of products, provided using the smallest unit of the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "min_price": { - "description": "Minimum price found in collection of products.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_price": { - "description": "Maximum price found in collection of products.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "attribute_counts": { - "description": "Returns number of products within attribute terms.", - "type": ["array", "null"], - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "term": { "description": "Term ID", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "count": { - "description": "Number of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "rating_counts": { - "description": "Returns number of products with each average rating.", - "type": ["array", "null"], - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "rating": { - "description": "Average rating", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "count": { - "description": "Number of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "stock_status_counts": { - "description": "Returns number of products with each stock status.", - "type": ["array", "null"], - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "status": { "description": "Status", "type": "string", "context": ["view", "edit"], "readonly": true }, - "count": { - "description": "Number of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "ai/store-title": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/store-title", - "type": "object", - "properties": [] - }, - "ai/images": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/images", - "type": "object", - "properties": [] - }, - "ai/patterns": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/patterns", - "type": "object", - "properties": [] - }, - "ai/product": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/product", - "type": "object", - "properties": [] - }, - "ai/products": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/products", - "type": "object", - "properties": [] - }, - "ai/business-description": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/business-description", - "type": "object", - "properties": [] - }, - "ai/store-info": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/store-info", - "type": "object", - "properties": [] - }, - "patterns": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "patterns", - "type": "object", - "properties": [] - }, - "webhook_delivery": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "webhook_delivery", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "duration": { - "description": "The delivery duration, in seconds.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "summary": { - "description": "A friendly summary of the response including the HTTP response code, message, and body.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "request_url": { - "description": "The URL where the webhook was delivered.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "request_headers": { - "description": "Request headers", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "request_body": { "description": "Request body", "type": "string", "context": ["view"], "readonly": true }, - "response_code": { - "description": "The HTTP response code from the receiving server.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "response_message": { - "description": "The HTTP response message from the receiving server.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "response_headers": { - "description": "Array of the response headers from the receiving server.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "response_body": { - "description": "The response body from the receiving server.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "date_created": { - "description": "The date the webhook delivery was logged, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the webhook delivery was logged, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "post": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "post", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "format": { - "description": "The format for the post.", - "type": "string", - "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"], - "context": ["view", "edit"] - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "sticky": { - "description": "Whether or not the post should be treated as sticky.", - "type": "boolean", - "context": ["view", "edit"] - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "categories": { - "description": "The terms assigned to the object in the category taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "tags": { - "description": "The terms assigned to the object in the post_tag taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-sticky", - "title": "The current user can sticky this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { "type": "object", "properties": { "sticky": { "type": "boolean" } } } - }, - { - "rel": "https:/api.w.org/action-assign-author", - "title": "The current user can change the author on this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } - }, - { - "rel": "https:/api.w.org/action-assign-categories", - "title": "The current user can assign terms in the category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "categories": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-categories", - "title": "The current user can create terms in the category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "categories": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-assign-tags", - "title": "The current user can assign terms in the post_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "tags": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-tags", - "title": "The current user can create terms in the post_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "tags": { "type": "array", "items": { "type": "integer" } } } - } - } - ] - }, - "post-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "post-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "page": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "page", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "context": ["view", "edit"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "menu_order": { - "description": "The order of the post in relation to other posts.", - "type": "integer", - "context": ["view", "edit"] - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-author", - "title": "The current user can change the author on this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", - "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } - } - ] - }, - "page-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "page-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "attachment": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "attachment", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "alt_text": { - "description": "Alternative text to display when attachment is not displayed.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "caption": { - "description": "The attachment caption.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Caption for the attachment, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML caption for the attachment, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "description": { - "description": "The attachment description.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Description for the attachment, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML description for the attachment, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "media_type": { - "description": "Attachment type.", - "type": "string", - "enum": ["image", "file"], - "context": ["view", "edit", "embed"], - "readonly": true - }, - "mime_type": { - "description": "The attachment MIME type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "media_details": { - "description": "Details about the media file, specific to its type.", - "type": "object", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "post": { - "description": "The ID for the associated post of the attachment.", - "type": "integer", - "context": ["view", "edit"] - }, - "source_url": { - "description": "URL to the original attachment file.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "missing_image_sizes": { - "description": "List of the missing image sizes of the attachment.", - "type": "array", - "items": { "type": "string" }, - "context": ["edit"], - "readonly": true - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-author", - "title": "The current user can change the author on this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", - "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } - } - ] - }, - "nav_menu_item": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "nav_menu_item", - "type": "object", - "properties": { - "title": { - "description": "The title for the object.", - "type": ["string", "object"], - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the object.", - "type": "integer", - "default": 0, - "minimum": 0, - "context": ["view", "edit", "embed"], - "readonly": true - }, - "type_label": { - "description": "The singular label used to describe this type of menu item.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "type": { - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "type": "string", - "enum": ["taxonomy", "post_type", "post_type_archive", "custom"], - "context": ["view", "edit", "embed"], - "default": "custom" - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "default": "publish", - "context": ["view", "edit", "embed"] - }, - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "minimum": 0, - "default": 0, - "context": ["view", "edit", "embed"] - }, - "attr_title": { - "description": "Text for the title attribute of the link element for this menu item.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "classes": { - "description": "Class names for the link element of this menu item.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The description of this menu item.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "menu_order": { - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", - "context": ["view", "edit", "embed"], - "type": "integer", - "minimum": 1, - "default": 1 - }, - "object": { - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", - "context": ["view", "edit", "embed"], "type": "string" }, - "object_id": { - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", - "context": ["view", "edit", "embed"], - "type": "integer", - "minimum": 0, - "default": 0 - }, - "target": { - "description": "The target attribute of the link element for this menu item.", - "type": "string", - "context": ["view", "edit", "embed"], - "enum": ["_blank", ""] - }, - "url": { - "description": "The URL to which this menu item points.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"] - }, - "xfn": { - "description": "The XFN relationship expressed in the link of this menu item.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "invalid": { - "description": "Whether the menu item represents an object that no longer exists .", - "context": ["view", "edit", "embed"], - "type": "boolean", - "readonly": true - }, - "menus": { - "description": "The terms assigned to the object in the nav_menu taxonomy.", - "type": "integer", - "context": ["view", "edit"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-menus", - "title": "The current user can assign terms in the nav_menu taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { - "type": "object", - "properties": { "menus": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-menus", - "title": "The current user can create terms in the nav_menu taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { - "type": "object", - "properties": { "menus": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/menu-item-object", - "title": "Get linked object.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { "type": "object", "properties": { "object": { "type": "integer" } } } - } - ] - }, - "nav_menu_item-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "nav_menu_item-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "GUID for the revision, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the object.", - "type": ["string", "object"], - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "wp_block": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_block", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_id": { + "context": [ + "edit", + "view" ], - "context": ["view", "edit"] + "default": 0, + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "wp_pattern_sync_status": { - "type": "string", - "description": "", - "default": "", - "enum": ["partial", "unsynced"] - }, - "footnotes": { "type": "string", "description": "", "default": "" } - } - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "wp_pattern_category": { - "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-wp_pattern_category", - "title": "The current user can assign terms in the wp_pattern_category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { - "type": "object", - "properties": { "wp_pattern_category": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-wp_pattern_category", - "title": "The current user can create terms in the wp_pattern_category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { - "type": "object", - "properties": { "wp_pattern_category": { "type": "array", "items": { "type": "integer" } } } - } - } - ] - }, - "wp_block-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_block-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "wp_pattern_sync_status": { - "type": "string", - "description": "", - "default": "", - "enum": ["partial", "unsynced"] - }, - "footnotes": { "type": "string", "description": "", "default": "" } - } - }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "wp_template": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_template", - "type": "object", - "properties": { - "id": { - "description": "ID of template.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "context": ["embed", "view", "edit"], - "required": true, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+" - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "type": { "description": "Type of template.", "type": "string", "context": ["embed", "view", "edit"] }, - "source": { - "description": "Source of template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "origin": { - "description": "Source of a customised template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "content": { - "description": "Content of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": ["edit"], - "readonly": true - } - } - }, - "title": { - "description": "Title of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "description": { - "description": "Description of template.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"] - }, - "status": { - "description": "Status of template.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_ip_address": { + "context": [ + "edit", + "view" ], - "default": "publish", - "context": ["embed", "view", "edit"] - }, - "wp_id": { - "description": "Post ID.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "has_theme_file": { - "description": "Theme file exists.", - "type": "bool", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the template was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "author_text": { - "type": "string", - "description": "Human readable text for the author.", + "description": "Customer's IP address.", "readonly": true, - "context": ["view", "edit", "embed"] + "type": "string" }, - "original_source": { - "description": "From where the template originally comes, eg 'theme'", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"], - "enum": ["theme", "plugin", "site", "user"] - }, - "is_custom": { - "description": "Whether a template is a custom template.", - "type": "bool", - "context": ["embed", "view", "edit"], - "readonly": true - } - } - }, - "wp_template_part": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_template_part", - "type": "object", - "properties": { - "id": { - "description": "ID of template.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "context": ["embed", "view", "edit"], - "required": true, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+" - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "type": { "description": "Type of template.", "type": "string", "context": ["embed", "view", "edit"] }, - "source": { - "description": "Source of template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "origin": { - "description": "Source of a customised template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "content": { - "description": "Content of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": ["edit"], - "readonly": true - } - } - }, - "title": { - "description": "Title of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "description": { - "description": "Description of template.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"] - }, - "status": { - "description": "Status of template.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_note": { + "context": [ + "edit", + "view" ], - "default": "publish", - "context": ["embed", "view", "edit"] + "description": "Note left by customer during checkout.", + "type": "string" }, - "wp_id": { - "description": "Post ID.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "has_theme_file": { - "description": "Theme file exists.", - "type": "bool", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the template was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "author_text": { - "type": "string", - "description": "Human readable text for the author.", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "original_source": { - "description": "From where the template originally comes, eg 'theme'", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"], - "enum": ["theme", "plugin", "site", "user"] - }, - "area": { - "description": "Where the template part is intended for use (header, footer, etc)", - "type": "string", - "context": ["embed", "view", "edit"] - } - } - }, - "wp_global_styles-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_global_styles-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "id": { - "description": "ID of global styles config.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "styles": { "description": "Global styles.", "type": ["object"], "context": ["view", "edit"] }, - "settings": { "description": "Global settings.", "type": ["object"], "context": ["view", "edit"] } - } - }, - "wp_global_styles": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_global_styles", - "type": "object", - "properties": { - "id": { - "description": "ID of global styles config.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "styles": { "description": "Global styles.", "type": ["object"], "context": ["view", "edit"] }, - "settings": { "description": "Global settings.", "type": ["object"], "context": ["view", "edit"] }, - "title": { - "description": "Title of the global styles variation.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Title for the global styles variation, as it exists in the database.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - } - } - }, - "wp_navigation": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_navigation", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_user_agent": { + "context": [ + "edit", + "view" ], - "context": ["view", "edit", "embed"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - } - ] - }, - "wp_navigation-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_navigation-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], + "description": "User agent of the customer.", "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true + "type": "string" + }, + "date_completed": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was completed, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_completed_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was completed, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the order was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_paid": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was paid, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_paid_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was paid, as GMT.", + "readonly": true, + "type": "date-time" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total discount tax amount for the order.", + "readonly": true, + "type": "string" + }, + "discount_total": { + "context": [ + "edit", + "view" + ], + "description": "Total discount amount for the order.", + "readonly": true, + "type": "string" + }, + "fee_lines": { + "context": [ + "edit", + "view" + ], + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } + "type": "object" + }, + "type": "array" }, "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] + "is_editable": { + "context": [ + "edit", + "view" + ], + "description": "Whether an order can be edited.", + "readonly": true, + "type": "boolean" }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] + "line_items": { + "context": [ + "edit", + "view" + ], + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": "mixed" + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": "mixed" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] + "needs_payment": { + "context": [ + "edit", + "view" + ], + "description": "Whether an order needs payment, based on status and order total.", + "readonly": true, + "type": "boolean" }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], + "needs_processing": { + "context": [ + "edit", + "view" + ], + "description": "Whether an order needs processing before it can be completed.", + "readonly": true, + "type": "boolean" + }, + "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": [ + "edit", + "view" + ], + "description": "Payment method title.", + "type": "string" + }, + "payment_url": { + "context": [ + "edit", + "view" + ], + "description": "Order payment URL.", + "readonly": true, + "type": "string" + }, + "prices_include_tax": { + "context": [ + "edit", + "view" + ], + "description": "True the prices included tax during checkout.", + "readonly": true, + "type": "boolean" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "List of refunds.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Refund ID.", + "readonly": true, + "type": "integer" + }, + "reason": { + "context": [ + "edit", + "view" + ], + "description": "Refund reason.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Refund total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "set_paid": { + "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": [ + "edit", + "view" + ], + "description": "Shipping address.", "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit", "embed"], - "readonly": true + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "wp_font_family": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_font_family", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "theme_json_version": { - "description": "Version of the theme.json schema used for the typography settings.", - "type": "integer", - "default": 3, - "minimum": 2, - "maximum": 3, - "context": ["view", "edit", "embed"] - }, - "font_faces": { - "description": "The IDs of the child font faces in the font family.", - "type": "array", - "context": ["view", "edit", "embed"], - "items": { "type": "integer" } - }, - "font_family_settings": { - "description": "font-face definition in theme.json format.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "name": { "description": "Name of the font family preset, translatable.", "type": "string" }, - "slug": { "description": "Kebab-case unique identifier for the font family preset.", "type": "string" }, - "fontFamily": { "description": "CSS font-family value.", "type": "string" }, - "preview": { - "description": "URL to a preview image of the font family.", - "type": "string", - "format": "uri", - "default": "" + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" } }, - "required": ["name", "slug", "fontFamily"], - "additionalProperties": false - } - } - }, - "wp_font_face": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_font_face", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true + "type": "object" }, - "theme_json_version": { - "description": "Version of the theme.json schema used for the typography settings.", - "type": "integer", - "default": 3, - "minimum": 2, - "maximum": 3, - "context": ["view", "edit", "embed"] - }, - "parent": { - "description": "The ID for the parent font family of the font face.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "font_face_settings": { - "description": "font-face declaration in theme.json format.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "fontFamily": { "description": "CSS font-family value.", "type": "string", "default": "" }, - "fontStyle": { "description": "CSS font-style value.", "type": "string", "default": "normal" }, - "fontWeight": { - "description": "List of available font weights, separated by a space.", - "default": "400", - "type": ["string", "integer"] + "shipping_lines": { + "context": [ + "edit", + "view" + ], + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": "mixed" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } }, - "fontDisplay": { - "description": "CSS font-display value.", - "type": "string", - "default": "fallback", - "enum": ["auto", "block", "fallback", "swap", "optional"] - }, - "src": { - "description": "Paths or URLs to the font files.", - "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], - "default": [] - }, - "fontStretch": { "description": "CSS font-stretch value.", "type": "string" }, - "ascentOverride": { "description": "CSS ascent-override value.", "type": "string" }, - "descentOverride": { "description": "CSS descent-override value.", "type": "string" }, - "fontVariant": { "description": "CSS font-variant value.", "type": "string" }, - "fontFeatureSettings": { "description": "CSS font-feature-settings value.", "type": "string" }, - "fontVariationSettings": { "description": "CSS font-variation-settings value.", "type": "string" }, - "lineGapOverride": { "description": "CSS line-gap-override value.", "type": "string" }, - "sizeAdjust": { "description": "CSS size-adjust value.", "type": "string" }, - "unicodeRange": { "description": "CSS unicode-range value.", "type": "string" }, - "preview": { - "description": "URL to a preview image of the font face.", - "type": "string", - "format": "uri", - "default": "" - } + "type": "object" }, - "required": ["fontFamily", "src"], - "additionalProperties": false - } - } - }, - "product-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "type": "array" }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total shipping tax amount for the order.", "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true + "type": "string" + }, + "shipping_total": { + "context": [ + "edit", + "view" + ], + "description": "Total shipping amount for the order.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "default": "pending", + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "type": "string" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Tax lines data.", + "items": { + "properties": { + "compound": { + "context": [ + "edit", + "view" + ], + "description": "Show if is a compound tax rate.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate label.", + "readonly": true, + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "rate_code": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate code.", + "readonly": true, + "type": "string" + }, + "rate_id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "shipping_tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax total.", + "readonly": true, + "type": "string" + }, + "tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total (not including shipping taxes).", + "readonly": true, + "type": "string" + } }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Grand total.", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Sum of all taxes.", + "readonly": true, + "type": "string" + }, + "transaction_id": { + "context": [ + "edit", + "view" + ], + "description": "Unique transaction ID.", + "type": "string" + }, + "version": { + "context": [ + "edit", + "view" + ], + "description": "Version of WooCommerce which last updated the order.", + "readonly": true, + "type": "string" + } + }, + "title": "shop_order", + "type": "object" + }, + "shop_order_refund": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Refund amount.", + "type": "string" + }, + "api_refund": { + "context": [ + "edit" + ], + "default": true, + "description": "When true, the payment gateway API is used to generate the refund.", + "type": "boolean" + }, + "date_created": { + "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": [ + "edit", + "view" + ], + "description": "The date the order refund was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "fee_lines": { + "context": [ + "edit", + "view" + ], + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" }, "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] + "line_items": { + "context": [ + "edit", + "view" + ], + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "readonly": true, + "type": "mixed" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "mixed" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "mixed" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "readonly": true, + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "readonly": true, + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "readonly": true, + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "readonly": true, + "type": "integer" + } }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } + "type": "object" + }, + "readonly": true, + "type": "array" }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } + "type": "object" + }, + "type": "array" }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } + "reason": { + "context": [ + "edit", + "view" + ], + "description": "Reason for refund.", + "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true + "refunded_by": { + "context": [ + "edit", + "view" + ], + "description": "User ID of user who created the refund.", + "type": "integer" + }, + "refunded_payment": { + "context": [ + "edit", + "view" + ], + "description": "If the payment was refunded via the API.", + "readonly": true, + "type": "boolean" + }, + "shipping_lines": { + "context": [ + "edit", + "view" + ], + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": "mixed" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Tax lines data.", + "items": { + "properties": { + "compound": { + "context": [ + "edit", + "view" + ], + "description": "Show if is a compound tax rate.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate label.", + "readonly": true, + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "rate_code": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate code.", + "readonly": true, + "type": "string" + }, + "rate_id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "shipping_tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax total.", + "readonly": true, + "type": "string" + }, + "tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total (not including shipping taxes).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" } - } + }, + "title": "shop_order_refund", + "type": "object" }, - "type": { + "sidebar": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "type", - "type": "object", "properties": { - "capabilities": { - "description": "All capabilities used by the post type.", - "type": "object", - "context": ["edit"], - "readonly": true + "after_title": { + "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": [ + "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": [ + "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": [ + "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": [ + "edit", + "embed", + "view" + ], + "description": "Extra CSS class to assign to the sidebar in the Widgets interface.", + "readonly": true, + "type": "string" }, "description": { - "description": "A human-readable description of the post type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true + "context": [ + "edit", + "embed", + "view" + ], + "description": "Description of sidebar.", + "readonly": true, + "type": "string" }, - "hierarchical": { - "description": "Whether or not the post type should have children.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "viewable": { - "description": "Whether or not the post type can be viewed.", - "type": "boolean", - "context": ["edit"], - "readonly": true - }, - "labels": { - "description": "Human-readable labels for the post type for various contexts.", - "type": "object", - "context": ["edit"], - "readonly": true + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of sidebar.", + "readonly": true, + "type": "string" }, "name": { - "description": "The title for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "supports": { - "description": "All features, supported by the post type.", - "type": "object", - "context": ["edit"], - "readonly": true - }, - "has_archive": { - "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.", - "type": ["string", "boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "taxonomies": { - "description": "Taxonomies associated with post type.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"], - "readonly": true - }, - "rest_base": { - "description": "REST base route for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "rest_namespace": { - "description": "REST route's namespace for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "visibility": { - "description": "The visibility settings for the post type.", - "type": "object", - "context": ["edit"], + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique name identifying the sidebar.", "readonly": true, - "properties": { - "show_ui": { - "description": "Whether to generate a default UI for managing this post type.", - "type": "boolean" - }, - "show_in_nav_menus": { - "description": "Whether to make the post type available for selection in navigation menus.", - "type": "boolean" - } - } + "type": "string" }, - "icon": { - "description": "The icon for the post type.", - "type": ["string", "null"], - "context": ["view", "edit", "embed"], - "readonly": true - }, - "template": { - "type": ["array"], - "description": "The block template associated with the post type.", + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Status of sidebar.", + "enum": [ + "active", + "inactive" + ], "readonly": true, - "context": ["view", "edit", "embed"] + "type": "string" }, - "template_lock": { - "type": ["string", "boolean"], - "enum": ["all", "insert", "contentOnly", false], - "description": "The template_lock associated with the post type, or false if none.", - "readonly": true, - "context": ["view", "edit", "embed"] + "widgets": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Nested widgets.", + "items": { + "type": [ + "object", + "string" + ] + }, + "type": "array" } - } + }, + "title": "sidebar", + "type": "object" }, "status": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "status", - "type": "object", "properties": { + "date_floating": { + "context": [ + "edit", + "view" + ], + "description": "Whether posts of this status may have floating published dates.", + "readonly": true, + "type": "boolean" + }, "name": { + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the status.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "readonly": true, + "type": "string" }, "private": { + "context": [ + "edit" + ], "description": "Whether posts with this status should be private.", - "type": "boolean", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "protected": { + "context": [ + "edit" + ], "description": "Whether posts with this status should be protected.", - "type": "boolean", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "public": { + "context": [ + "edit", + "view" + ], "description": "Whether posts of this status should be shown in the front end of the site.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "queryable": { + "context": [ + "edit", + "view" + ], "description": "Whether posts with this status should be publicly-queryable.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "show_in_list": { + "context": [ + "edit" + ], "description": "Whether to include posts in the edit listing for their post type.", - "type": "boolean", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "slug": { + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the status.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "date_floating": { - "description": "Whether posts of this status may have floating published dates.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "string" } - } + }, + "title": "status", + "type": "object" + }, + "system_status": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "active_plugins": { + "context": [ + "view" + ], + "description": "Active plugins.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "database": { + "context": [ + "view" + ], + "description": "Database.", + "properties": { + "database_prefix": { + "context": [ + "view" + ], + "description": "Database prefix.", + "readonly": true, + "type": "string" + }, + "database_tables": { + "context": [ + "view" + ], + "description": "Database tables.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "maxmind_geoip_database": { + "context": [ + "view" + ], + "description": "MaxMind GeoIP database.", + "readonly": true, + "type": "string" + }, + "wc_database_version": { + "context": [ + "view" + ], + "description": "WC database version.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "dropins_mu_plugins": { + "context": [ + "view" + ], + "description": "Dropins & MU plugins.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "environment": { + "context": [ + "view" + ], + "description": "Environment.", + "properties": { + "curl_version": { + "context": [ + "view" + ], + "description": "cURL version.", + "readonly": true, + "type": "string" + }, + "default_timezone": { + "context": [ + "view" + ], + "description": "Default timezone.", + "readonly": true, + "type": "string" + }, + "domdocument_enabled": { + "context": [ + "view" + ], + "description": "Is DomDocument class enabled?", + "readonly": true, + "type": "boolean" + }, + "fsockopen_or_curl_enabled": { + "context": [ + "view" + ], + "description": "Is fsockopen/cURL enabled?", + "readonly": true, + "type": "boolean" + }, + "gzip_enabled": { + "context": [ + "view" + ], + "description": "Is GZip enabled?", + "readonly": true, + "type": "boolean" + }, + "home_url": { + "context": [ + "view" + ], + "description": "Home URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "language": { + "context": [ + "view" + ], + "description": "WordPress language.", + "readonly": true, + "type": "string" + }, + "log_directory": { + "context": [ + "view" + ], + "description": "Log directory.", + "readonly": true, + "type": "string" + }, + "log_directory_writable": { + "context": [ + "view" + ], + "description": "Is log directory writable?", + "readonly": true, + "type": "boolean" + }, + "max_upload_size": { + "context": [ + "view" + ], + "description": "Max upload size.", + "readonly": true, + "type": "integer" + }, + "mbstring_enabled": { + "context": [ + "view" + ], + "description": "Is mbstring enabled?", + "readonly": true, + "type": "boolean" + }, + "mysql_version": { + "context": [ + "view" + ], + "description": "MySQL version.", + "readonly": true, + "type": "string" + }, + "mysql_version_string": { + "context": [ + "view" + ], + "description": "MySQL version string.", + "readonly": true, + "type": "string" + }, + "php_max_execution_time": { + "context": [ + "view" + ], + "description": "PHP max execution time.", + "readonly": true, + "type": "integer" + }, + "php_max_input_vars": { + "context": [ + "view" + ], + "description": "PHP max input vars.", + "readonly": true, + "type": "integer" + }, + "php_post_max_size": { + "context": [ + "view" + ], + "description": "PHP post max size.", + "readonly": true, + "type": "integer" + }, + "php_version": { + "context": [ + "view" + ], + "description": "PHP version.", + "readonly": true, + "type": "string" + }, + "remote_get_response": { + "context": [ + "view" + ], + "description": "Remote GET response.", + "readonly": true, + "type": "string" + }, + "remote_get_successful": { + "context": [ + "view" + ], + "description": "Remote GET successful?", + "readonly": true, + "type": "boolean" + }, + "remote_post_response": { + "context": [ + "view" + ], + "description": "Remote POST response.", + "readonly": true, + "type": "string" + }, + "remote_post_successful": { + "context": [ + "view" + ], + "description": "Remote POST successful?", + "readonly": true, + "type": "boolean" + }, + "server_info": { + "context": [ + "view" + ], + "description": "Server info.", + "readonly": true, + "type": "string" + }, + "site_url": { + "context": [ + "view" + ], + "description": "Site URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "soapclient_enabled": { + "context": [ + "view" + ], + "description": "Is SoapClient class enabled?", + "readonly": true, + "type": "boolean" + }, + "store_id": { + "context": [ + "view" + ], + "description": "WooCommerce Store Identifier.", + "readonly": true, + "type": "string" + }, + "suhosin_installed": { + "context": [ + "view" + ], + "description": "Is SUHOSIN installed?", + "readonly": true, + "type": "boolean" + }, + "version": { + "context": [ + "view" + ], + "description": "WooCommerce version.", + "readonly": true, + "type": "string" + }, + "wp_cron": { + "context": [ + "view" + ], + "description": "Are WordPress cron jobs enabled?", + "readonly": true, + "type": "boolean" + }, + "wp_debug_mode": { + "context": [ + "view" + ], + "description": "Is WordPress debug mode active?", + "readonly": true, + "type": "boolean" + }, + "wp_memory_limit": { + "context": [ + "view" + ], + "description": "WordPress memory limit.", + "readonly": true, + "type": "integer" + }, + "wp_multisite": { + "context": [ + "view" + ], + "description": "Is WordPress multisite?", + "readonly": true, + "type": "boolean" + }, + "wp_version": { + "context": [ + "view" + ], + "description": "WordPress version.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "inactive_plugins": { + "context": [ + "view" + ], + "description": "Inactive plugins.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "logging": { + "context": [ + "view" + ], + "description": "Logging.", + "properties": { + "default_handler": { + "context": [ + "view" + ], + "description": "The logging handler class.", + "readonly": true, + "type": "string" + }, + "level_threshold": { + "context": [ + "view" + ], + "description": "Minimum severity level.", + "readonly": true, + "type": "string" + }, + "log_directory_size": { + "context": [ + "view" + ], + "description": "The size of the log directory.", + "readonly": true, + "type": "string" + }, + "logging_enabled": { + "context": [ + "view" + ], + "description": "Is logging enabled?", + "readonly": true, + "type": "boolean" + }, + "retention_period_days": { + "context": [ + "view" + ], + "description": "The number of days log entries are retained.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "pages": { + "context": [ + "view" + ], + "description": "WooCommerce pages.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "post_type_counts": { + "context": [ + "view" + ], + "description": "Total post count.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "security": { + "context": [ + "view" + ], + "description": "Security.", + "properties": { + "hide_errors": { + "context": [ + "view" + ], + "description": "Hide errors from visitors?", + "readonly": true, + "type": "boolean" + }, + "secure_connection": { + "context": [ + "view" + ], + "description": "Is the connection to your store secure?", + "readonly": true, + "type": "boolean" + } + }, + "readonly": true, + "type": "object" + }, + "settings": { + "context": [ + "view" + ], + "description": "Settings.", + "properties": { + "HPOS_enabled": { + "context": [ + "view" + ], + "description": "Is HPOS enabled?", + "readonly": true, + "type": "boolean" + }, + "HPOS_sync_enabled": { + "context": [ + "view" + ], + "description": "Is HPOS sync enabled?", + "readonly": true, + "type": "boolean" + }, + "api_enabled": { + "context": [ + "view" + ], + "description": "Legacy REST API enabled?", + "readonly": true, + "type": "boolean" + }, + "currency": { + "context": [ + "view" + ], + "description": "Currency.", + "readonly": true, + "type": "string" + }, + "currency_position": { + "context": [ + "view" + ], + "description": "Currency position.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "context": [ + "view" + ], + "description": "Currency symbol.", + "readonly": true, + "type": "string" + }, + "decimal_separator": { + "context": [ + "view" + ], + "description": "Decimal separator.", + "readonly": true, + "type": "string" + }, + "enforce_approved_download_dirs": { + "context": [ + "view" + ], + "description": "Enforce approved download directories?", + "readonly": true, + "type": "boolean" + }, + "force_ssl": { + "context": [ + "view" + ], + "description": "SSL forced?", + "readonly": true, + "type": "boolean" + }, + "geolocation_enabled": { + "context": [ + "view" + ], + "description": "Geolocation enabled?", + "readonly": true, + "type": "boolean" + }, + "number_of_decimals": { + "context": [ + "view" + ], + "description": "Number of decimals.", + "readonly": true, + "type": "integer" + }, + "order_datastore": { + "context": [ + "view" + ], + "description": "Order datastore.", + "readonly": true, + "type": "string" + }, + "product_visibility_terms": { + "context": [ + "view" + ], + "description": "Terms in the product visibility taxonomy.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "taxonomies": { + "context": [ + "view" + ], + "description": "Taxonomy terms for product/order statuses.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "thousand_separator": { + "context": [ + "view" + ], + "description": "Thousand separator.", + "readonly": true, + "type": "string" + }, + "wccom_connected": { + "context": [ + "view" + ], + "description": "Is store connected to WooCommerce.com?", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "theme": { + "context": [ + "view" + ], + "description": "Theme.", + "properties": { + "author_url": { + "context": [ + "view" + ], + "description": "Theme author URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "has_outdated_templates": { + "context": [ + "view" + ], + "description": "Does this theme have outdated templates?", + "readonly": true, + "type": "boolean" + }, + "has_woocommerce_file": { + "context": [ + "view" + ], + "description": "Does the theme have a woocommerce.php file?", + "readonly": true, + "type": "boolean" + }, + "has_woocommerce_support": { + "context": [ + "view" + ], + "description": "Does the theme declare WooCommerce support?", + "readonly": true, + "type": "boolean" + }, + "is_child_theme": { + "context": [ + "view" + ], + "description": "Is this theme a child theme?", + "readonly": true, + "type": "boolean" + }, + "name": { + "context": [ + "view" + ], + "description": "Theme name.", + "readonly": true, + "type": "string" + }, + "overrides": { + "context": [ + "view" + ], + "description": "Template overrides.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "parent_author_url": { + "context": [ + "view" + ], + "description": "Parent theme author URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "parent_name": { + "context": [ + "view" + ], + "description": "Parent theme name.", + "readonly": true, + "type": "string" + }, + "parent_version": { + "context": [ + "view" + ], + "description": "Parent theme version.", + "readonly": true, + "type": "string" + }, + "version": { + "context": [ + "view" + ], + "description": "Theme version.", + "readonly": true, + "type": "string" + }, + "version_latest": { + "context": [ + "view" + ], + "description": "Latest version of theme.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "system_status", + "type": "object" + }, + "system_status_tool": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "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" + }, + "tag": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "post_tag" + ], + "readonly": true, + "type": "string" + } + }, + "title": "tag", + "type": "object" + }, + "tax": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "class": { + "context": [ + "edit", + "view" + ], + "default": "standard", + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "type": "string" + }, + "compound": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country ISO 3166 code.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "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": [ + "edit", + "view" + ], + "default": true, + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State code.", + "type": "string" + } + }, + "title": "tax", + "type": "object" + }, + "tax_class": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax class name.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "string" + } + }, + "title": "tax_class", + "type": "object" }, "taxonomy": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "taxonomy", - "type": "object", "properties": { "capabilities": { + "context": [ + "edit" + ], "description": "All capabilities used by the taxonomy.", - "type": "object", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "object" }, "description": { + "context": [ + "edit", + "view" + ], "description": "A human-readable description of the taxonomy.", - "type": "string", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "string" }, "hierarchical": { + "context": [ + "edit", + "view" + ], "description": "Whether or not the taxonomy should have children.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "labels": { + "context": [ + "edit" + ], "description": "Human-readable labels for the taxonomy for various contexts.", - "type": "object", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "object" }, "name": { + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "show_cloud": { - "description": "Whether or not the term cloud should be displayed.", - "type": "boolean", - "context": ["edit"], - "readonly": true - }, - "types": { - "description": "Types associated with the taxonomy.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "string" }, "rest_base": { + "context": [ + "edit", + "embed", + "view" + ], "description": "REST base route for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "readonly": true, + "type": "string" }, "rest_namespace": { + "context": [ + "edit", + "embed", + "view" + ], "description": "REST namespace route for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "readonly": true, + "type": "string" + }, + "show_cloud": { + "context": [ + "edit" + ], + "description": "Whether or not the term cloud should be displayed.", + "readonly": true, + "type": "boolean" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the taxonomy.", + "readonly": true, + "type": "string" + }, + "types": { + "context": [ + "edit", + "view" + ], + "description": "Types associated with the taxonomy.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" }, "visibility": { + "context": [ + "edit" + ], "description": "The visibility settings for the taxonomy.", - "type": "object", - "context": ["edit"], - "readonly": true, "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" }, - "show_ui": { - "description": "Whether to generate a default UI for managing this taxonomy.", + "publicly_queryable": { + "description": "Whether the taxonomy is publicly queryable.", "type": "boolean" }, "show_admin_column": { @@ -13657,11986 +21878,4310 @@ "show_in_quick_edit": { "description": "Whether to show the taxonomy in the Quick/Bulk edit panel.", "type": "boolean" + }, + "show_ui": { + "description": "Whether to generate a default UI for managing this taxonomy.", + "type": "boolean" } - } - } - } - }, - "category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "category", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["category"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "parent": { "description": "The parent term ID.", "type": "integer", "context": ["view", "edit"] }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "tag": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "tag", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["post_tag"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "nav_menu": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "nav_menu", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "locations": { - "description": "The locations assigned to the menu.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"] - }, - "auto_add": { - "description": "Whether to automatically add top-level pages to this menu.", - "context": ["view", "edit"], - "type": "boolean" - } - } - }, - "wp_pattern_category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_pattern_category", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["wp_pattern_category"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "user": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "user", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the user.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "username": { - "description": "Login name for the user.", - "type": "string", - "context": ["edit"], - "required": true - }, - "name": { - "description": "Display name for the user.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "first_name": { "description": "First name for the user.", "type": "string", "context": ["edit"] }, - "last_name": { "description": "Last name for the user.", "type": "string", "context": ["edit"] }, - "email": { - "description": "The email address for the user.", - "type": "string", - "format": "email", - "context": ["edit"], - "required": true - }, - "url": { - "description": "URL of the user.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "description": { - "description": "Description of the user.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "link": { - "description": "Author URL of the user.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "locale": { - "description": "Locale for the user.", - "type": "string", - "enum": ["", "en_US", "en_GB", "fr_BE", "fr_FR"], - "context": ["edit"] - }, - "nickname": { "description": "The nickname for the user.", "type": "string", "context": ["edit"] }, - "slug": { - "description": "An alphanumeric identifier for the user.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "registered_date": { - "description": "Registration date for the user.", - "type": "string", - "format": "date-time", - "context": ["edit"], - "readonly": true - }, - "roles": { - "description": "Roles assigned to the user.", - "type": "array", - "items": { "type": "string" }, - "context": ["edit"] - }, - "password": { - "description": "Password for the user (never included).", - "type": "string", - "context": [], - "required": true - }, - "capabilities": { - "description": "All capabilities assigned to the user.", - "type": "object", - "context": ["edit"], - "readonly": true - }, - "extra_capabilities": { - "description": "Any extra capabilities assigned to the user.", - "type": "object", - "context": ["edit"], - "readonly": true - }, - "avatar_urls": { - "description": "Avatar URLs for the user.", - "type": "object", - "context": ["embed", "view", "edit"], + }, "readonly": true, - "properties": { - "24": { - "description": "Avatar URL with image size of 24 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "48": { - "description": "Avatar URL with image size of 48 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "96": { - "description": "Avatar URL with image size of 96 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "persisted_preferences": { - "type": "object", - "description": "", - "default": [], - "context": ["edit"], - "properties": { - "_modified": { - "description": "The date and time the preferences were updated.", - "type": "string", - "format": "date-time", - "readonly": false - } - }, - "additionalProperties": true - }, - "woocommerce_launch_your_store_tour_hidden": { - "type": "string", - "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", - "default": "" - }, - "woocommerce_coming_soon_banner_dismissed": { - "type": "string", - "description": "Indicate whether the user has dismissed the coming soon notice or not.", - "default": "" - } - } + "type": "object" } - } + }, + "title": "taxonomy", + "type": "object" }, - "application-password": { + "term": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "application-password", - "type": "object", "properties": { - "uuid": { - "description": "The unique identifier for the application password.", - "type": "string", - "format": "uuid", - "context": ["view", "edit", "embed"], - "readonly": true + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of objects (posts of any type) assigned to the term.", + "readonly": true, + "type": "integer" }, - "app_id": { - "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", - "format": "uuid", - "context": ["view", "edit", "embed"] + "description": { + "context": [ + "edit", + "view" + ], + "description": "Term description.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, "name": { - "description": "The name of the application password.", - "type": "string", - "required": true, - "context": ["view", "edit", "embed"], - "minLength": 1, - "pattern": ".*\\S.*" - }, - "password": { - "description": "The generated password. Only available after adding an application.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "created": { - "description": "The GMT date the application password was created.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "last_used": { - "description": "The GMT date the application password was last used.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "last_ip": { - "description": "The IP address the application password was last used by.", - "type": ["string", "null"], - "format": "ip", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "comment": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "comment", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the comment.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "author": { - "description": "The ID of the user object, if author was a user.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "author_email": { - "description": "Email address for the comment author.", - "type": "string", - "format": "email", - "context": ["edit"] - }, - "author_ip": { - "description": "IP address for the comment author.", - "type": "string", - "format": "ip", - "context": ["edit"] - }, - "author_name": { - "description": "Display name for the comment author.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "author_url": { - "description": "URL for the comment author.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"] - }, - "author_user_agent": { - "description": "User agent for the comment author.", - "type": "string", - "context": ["edit"] - }, - "content": { - "description": "The content for the comment.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Content for the comment, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the comment, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "date": { - "description": "The date the comment was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the comment was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "link": { - "description": "URL to the comment.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" }, "parent": { - "description": "The ID for the parent of the comment.", - "type": "integer", - "context": ["view", "edit", "embed"], - "default": 0 - }, - "post": { - "description": "The ID of the associated post object.", - "type": "integer", - "context": ["view", "edit"], - "default": 0 - }, - "status": { "description": "State of the comment.", "type": "string", "context": ["view", "edit"] }, - "type": { - "description": "Type of the comment.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "author_avatar_urls": { - "description": "Avatar URLs for the comment author.", - "type": "object", - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "view" + ], + "description": "Parent term ID, if applicable.", "readonly": true, - "properties": { - "24": { - "description": "Avatar URL with image size of 24 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "48": { - "description": "Avatar URL with image size of 48 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "96": { - "description": "Avatar URL with image size of 96 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - } - } + "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "search-result": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "search-result", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the object.", - "type": ["integer", "string"], - "context": ["view", "embed"], - "readonly": true - }, - "title": { - "description": "The title for the object.", - "type": "string", - "context": ["view", "embed"], - "readonly": true - }, - "url": { - "description": "URL to the object.", - "type": "string", - "format": "uri", - "context": ["view", "embed"], - "readonly": true - }, - "type": { - "description": "Object type.", - "type": "string", - "enum": ["post", "term", "post-format"], - "context": ["view", "embed"], - "readonly": true - }, - "subtype": { - "description": "Object subtype.", - "type": "string", - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag"], - "context": ["view", "embed"], - "readonly": true - } - } - }, - "rendered-block": { - "$schema": "http:/json-schema.org/schema#", - "title": "rendered-block", - "type": "object", - "properties": { - "rendered": { "description": "The rendered block.", "type": "string", "required": true, "context": ["edit"] } - } - }, - "block-type": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-type", - "type": "object", - "properties": { - "api_version": { - "description": "Version of block API.", - "type": "integer", - "default": 1, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "title": { - "description": "Title of block type.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "name": { - "description": "Unique name identifying the block type.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "description": { - "description": "Description of block type.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "icon": { - "description": "Icon of block type.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "attributes": { - "description": "Block attributes.", - "type": ["object", "null"], - "properties": [], - "default": null, - "additionalProperties": { "type": "object" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "provides_context": { - "description": "Context provided by blocks of this type.", - "type": "object", - "properties": [], - "additionalProperties": { "type": "string" }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "uses_context": { - "description": "Context values inherited by blocks of this type.", - "type": "array", - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "selectors": { - "description": "Custom CSS selectors.", - "type": "object", - "default": [], - "properties": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "supports": { - "description": "Block supports.", - "type": "object", - "default": [], - "properties": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "category": { - "description": "Block category.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "is_dynamic": { - "description": "Is the block dynamically rendered.", - "type": "boolean", - "default": false, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_script_handles": { - "description": "Editor script handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "script_handles": { - "description": "Public facing and editor script handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_script_handles": { - "description": "Public facing script handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_script_module_ids": { - "description": "Public-facing script module IDs.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_style_handles": { - "description": "Editor style handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "style_handles": { - "description": "Public facing and editor style handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_style_handles": { - "description": "Public-facing style handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "styles": { - "description": "Block style variations.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { "description": "Unique name identifying the style.", "type": "string", "required": true }, - "label": { "description": "The human-readable label for the style.", "type": "string" }, - "inline_style": { - "description": "Inline CSS code that registers the CSS class required for the style.", - "type": "string" - }, - "style_handle": { "description": "Contains the handle that defines the block style.", "type": "string" } - } - }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "variations": { - "description": "Block variations.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { "description": "The unique and machine-readable name.", "type": "string", "required": true }, - "title": { "description": "A human-readable variation title.", "type": "string", "required": true }, - "description": { - "description": "A detailed variation description.", - "type": "string", - "required": false - }, - "category": { - "description": "Block category.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "icon": { - "description": "Icon of block type.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "isDefault": { - "description": "Indicates whether the current variation is the default one.", - "type": "boolean", - "required": false, - "default": false - }, - "attributes": { "description": "The initial values for attributes.", "type": "object" }, - "innerBlocks": { - "description": "The list of inner blocks used in the example.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the inner block.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true - }, - "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" - } - } - } - }, - "example": { - "description": "Block example.", - "type": ["object", "null"], - "default": null, - "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, - "innerBlocks": { - "description": "The list of inner blocks used in the example.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the inner block.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true - }, - "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" - } - } - } - } - }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "scope": { - "description": "The list of scopes where the variation is applicable. When not provided, it assumes all available scopes.", - "type": ["array", "null"], - "default": null, - "items": { "type": "string", "enum": ["block", "inserter", "transform"] }, - "readonly": true - }, - "keywords": { - "description": "Block keywords.", - "type": "array", - "items": { "type": "string" }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - } - } - }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "String based identifier for the term.", "readonly": true, - "context": ["embed", "view", "edit"], - "default": null - }, - "textdomain": { - "description": "Public text domain.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "parent": { - "description": "Parent blocks.", - "type": ["array", "null"], - "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$" }, - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "ancestor": { - "description": "Ancestor blocks.", - "type": ["array", "null"], - "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$" }, - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "allowed_blocks": { - "description": "Allowed child block types.", - "type": ["array", "null"], - "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$" }, - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "keywords": { - "description": "Block keywords.", - "type": "array", - "items": { "type": "string" }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "example": { - "description": "Block example.", - "type": ["object", "null"], - "default": null, - "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, - "innerBlocks": { - "description": "The list of inner blocks used in the example.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the inner block.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true - }, - "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" - } - } - } - } - }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "block_hooks": { - "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.", - "type": "object", - "patternProperties": { - "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$": { - "type": "string", - "enum": ["before", "after", "first_child", "last_child"] - } - }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_script": { - "description": "Editor script handle. DEPRECATED: Use `editor_script_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "script": { - "description": "Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_script": { - "description": "Public facing script handle. DEPRECATED: Use `view_script_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_style": { - "description": "Editor style handle. DEPRECATED: Use `editor_style_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "style": { - "description": "Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true + "type": "string" } - } - }, - "settings": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "settings", - "type": "object", - "properties": { - "title": { "type": "string", "title": "Title", "description": "Site title.", "default": null }, - "description": { "type": "string", "title": "Tagline", "description": "Site tagline.", "default": null }, - "url": { "type": "string", "title": "", "description": "Site URL.", "default": null, "format": "uri" }, - "email": { - "type": "string", - "title": "", - "description": "This address is used for admin purposes, like new user notification.", - "default": null, - "format": "email" - }, - "timezone": { - "type": "string", - "title": "", - "description": "A city in the same timezone as you.", - "default": null - }, - "date_format": { - "type": "string", - "title": "", - "description": "A date format for all date strings.", - "default": null - }, - "time_format": { - "type": "string", - "title": "", - "description": "A time format for all time strings.", - "default": null - }, - "start_of_week": { - "type": "integer", - "title": "", - "description": "A day number of the week that the week should start on.", - "default": null - }, - "language": { "type": "string", "title": "", "description": "WordPress locale code.", "default": "en_US" }, - "use_smilies": { - "type": "boolean", - "title": "", - "description": "Convert emoticons like :-) and :-P to graphics on display.", - "default": true - }, - "default_category": { - "type": "integer", - "title": "", - "description": "Default post category.", - "default": null - }, - "default_post_format": { - "type": "string", - "title": "", - "description": "Default post format.", - "default": null - }, - "posts_per_page": { - "type": "integer", - "title": "Maximum posts per page", - "description": "Blog pages show at most.", - "default": 10 - }, - "show_on_front": { - "type": "string", - "title": "Show on front", - "description": "What to show on the front page", - "default": null - }, - "page_on_front": { - "type": "integer", - "title": "Page on front", - "description": "The ID of the page that should be displayed on the front page", - "default": null - }, - "page_for_posts": { - "type": "integer", - "title": "", - "description": "The ID of the page that should display the latest posts", - "default": null - }, - "default_ping_status": { - "type": "string", - "title": "", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", - "default": null, - "enum": ["open", "closed"] - }, - "default_comment_status": { - "type": "string", - "title": "Allow comments on new posts", - "description": "Allow people to submit comments on new posts.", - "default": null, - "enum": ["open", "closed"] - }, - "site_logo": { "type": "integer", "title": "Logo", "description": "Site logo.", "default": null }, - "site_icon": { "type": "integer", "title": "Icon", "description": "Site icon.", "default": null }, - "pickup_location_settings": { - "type": "object", - "title": "", - "description": "WooCommerce Local Pickup Method Settings", - "default": [], - "properties": { - "enabled": { - "description": "If enabled, this method will appear on the block based checkout.", - "type": "string", - "enum": ["yes", "no"] - }, - "title": { - "description": "This controls the title which the user sees during checkout.", - "type": "string" - }, - "tax_status": { - "description": "If a cost is defined, this controls if taxes are applied to that cost.", - "type": "string", - "enum": ["taxable", "none"] - }, - "cost": { "description": "Optional cost to charge for local pickup.", "type": "string" } - }, - "additionalProperties": false - }, - "pickup_locations": { - "type": "array", - "title": "", - "description": "WooCommerce Local Pickup Locations", - "default": [], - "items": { - "type": "object", - "properties": { - "name": { "type": "string" }, - "address": { - "type": "object", - "properties": { - "address_1": { "type": "string" }, - "city": { "type": "string" }, - "state": { "type": "string" }, - "postcode": { "type": "string" }, - "country": { "type": "string" } - }, - "additionalProperties": false - }, - "details": { "type": "string" }, - "enabled": { "type": "boolean" } - }, - "additionalProperties": false - } - } - } + }, + "title": "term", + "type": "object" }, "theme": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "theme", - "type": "object", "properties": { - "stylesheet": { - "description": "The theme's style sheet. This uniquely identifies the theme.", - "type": "string", - "readonly": true - }, - "stylesheet_uri": { - "description": "The URI for the theme's style sheet directory.", - "type": "string", - "format": "uri", - "readonly": true - }, - "template": { - "description": "The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet.", - "type": "string", - "readonly": true - }, - "template_uri": { - "description": "The URI for the theme's template directory. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet directory.", - "type": "string", - "format": "uri", - "readonly": true - }, "author": { "description": "The theme author.", - "type": "object", - "readonly": true, "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" }, "author_uri": { "description": "The website of the theme author.", - "type": "object", - "readonly": true, "properties": { "raw": { "description": "The website of the theme author, as found in the theme header.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" }, "rendered": { "description": "The website of the theme author, transformed for display.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" } - } + }, + "readonly": true, + "type": "object" }, "description": { "description": "A description of the theme.", - "type": "object", - "readonly": true, "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" }, "is_block_theme": { "description": "Whether the theme is a block-based theme.", - "type": "boolean", - "readonly": true + "readonly": true, + "type": "boolean" }, "name": { "description": "The name of the theme.", - "type": "object", - "readonly": true, "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" }, "requires_php": { "description": "The minimum PHP version required for the theme to work.", - "type": "string", - "readonly": true + "readonly": true, + "type": "string" }, "requires_wp": { "description": "The minimum WordPress version required for the theme to work.", - "type": "string", - "readonly": true + "readonly": true, + "type": "string" }, "screenshot": { "description": "The theme's screenshot URL.", - "type": "string", "format": "uri", - "readonly": true + "readonly": true, + "type": "string" + }, + "status": { + "description": "A named status for the theme.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "stylesheet": { + "description": "The theme's style sheet. This uniquely identifies the theme.", + "readonly": true, + "type": "string" + }, + "stylesheet_uri": { + "description": "The URI for the theme's style sheet directory.", + "format": "uri", + "readonly": true, + "type": "string" }, "tags": { "description": "Tags indicating styles and features of the theme.", - "type": "object", - "readonly": true, "properties": { "raw": { "description": "The theme tags, as found in the theme header.", - "type": "array", - "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" + }, + "template": { + "description": "The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet.", + "readonly": true, + "type": "string" + }, + "template_uri": { + "description": "The URI for the theme's template directory. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet directory.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "textdomain": { + "description": "The theme's text domain.", + "readonly": true, + "type": "string" }, - "textdomain": { "description": "The theme's text domain.", "type": "string", "readonly": true }, "theme_supports": { "description": "Features supported by this theme.", - "type": "object", - "readonly": true, "properties": { "align-wide": { + "default": false, "description": "Whether theme opts in to wide alignment CSS class.", - "type": "boolean", - "default": false + "type": "boolean" }, "automatic-feed-links": { + "default": false, "description": "Whether posts and comments RSS feed links are added to head.", - "type": "boolean", - "default": false - }, - "block-templates": { - "description": "Whether a theme uses block-based templates.", - "type": "boolean", - "default": false + "type": "boolean" }, "block-template-parts": { + "default": false, "description": "Whether a theme uses block-based template parts.", - "type": "boolean", - "default": false + "type": "boolean" + }, + "block-templates": { + "default": false, + "description": "Whether a theme uses block-based templates.", + "type": "boolean" }, "custom-background": { - "description": "Custom background if defined by the theme.", - "type": ["boolean", "object"], + "additionalProperties": false, "default": false, + "description": "Custom background if defined by the theme.", "properties": { - "default-image": { "type": "string", "format": "uri" }, - "default-preset": { "type": "string", "enum": ["default", "fill", "fit", "repeat", "custom"] }, - "default-position-x": { "type": "string", "enum": ["left", "center", "right"] }, - "default-position-y": { "type": "string", "enum": ["left", "center", "right"] }, - "default-size": { "type": "string", "enum": ["auto", "contain", "cover"] }, - "default-repeat": { "type": "string", "enum": ["repeat-x", "repeat-y", "repeat", "no-repeat"] }, - "default-attachment": { "type": "string", "enum": ["scroll", "fixed"] }, - "default-color": { "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" + } }, - "additionalProperties": false + "type": [ + "boolean", + "object" + ] }, "custom-header": { - "description": "Custom header if defined by the theme.", - "type": ["boolean", "object"], + "additionalProperties": false, "default": false, + "description": "Custom header if defined by the theme.", "properties": { - "default-image": { "type": "string", "format": "uri" }, - "random-default": { "type": "boolean" }, - "width": { "type": "integer" }, - "height": { "type": "integer" }, - "flex-height": { "type": "boolean" }, - "flex-width": { "type": "boolean" }, - "default-text-color": { "type": "string" }, - "header-text": { "type": "boolean" }, - "uploads": { "type": "boolean" }, - "video": { "type": "boolean" } + "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" + } }, - "additionalProperties": false + "type": [ + "boolean", + "object" + ] }, "custom-logo": { - "description": "Custom logo if defined by the theme.", - "type": ["boolean", "object"], + "additionalProperties": false, "default": false, + "description": "Custom logo if defined by the theme.", "properties": { - "width": { "type": "integer" }, - "height": { "type": "integer" }, - "flex-width": { "type": "boolean" }, - "flex-height": { "type": "boolean" }, - "header-text": { "type": "array", "items": { "type": "string" } }, - "unlink-homepage-logo": { "type": "boolean" } + "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" + } }, - "additionalProperties": false + "type": [ + "boolean", + "object" + ] }, "customize-selective-refresh-widgets": { + "default": false, "description": "Whether the theme enables Selective Refresh for Widgets being managed with the Customizer.", - "type": "boolean", - "default": false + "type": "boolean" }, "dark-editor-style": { + "default": false, "description": "Whether theme opts in to the dark editor style UI.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-custom-colors": { + "default": false, "description": "Whether the theme disables custom colors.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-custom-font-sizes": { + "default": false, "description": "Whether the theme disables custom font sizes.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-custom-gradients": { + "default": false, "description": "Whether the theme disables custom gradients.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-layout-styles": { + "default": false, "description": "Whether the theme disables generated layout styles.", - "type": "boolean", - "default": false + "type": "boolean" }, "editor-color-palette": { - "description": "Custom color palette if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom color palette if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "slug": { "type": "string" }, - "color": { "type": "string" } + "color": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-font-sizes": { - "description": "Custom font sizes if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom font sizes if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "number" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "number" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-gradient-presets": { - "description": "Custom gradient presets if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom gradient presets if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "gradient": { "type": "string" }, - "slug": { "type": "string" } + "gradient": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-spacing-sizes": { - "description": "Custom spacing sizes if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom spacing sizes if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "string" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-styles": { - "description": "Whether theme opts in to the editor styles CSS wrapper.", - "type": "boolean", - "default": false - }, - "html5": { - "description": "Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.", - "type": ["boolean", "array"], "default": false, - "items": { - "type": "string", - "enum": ["search-form", "comment-form", "comment-list", "gallery", "caption", "script", "style"] - } + "description": "Whether theme opts in to the editor styles CSS wrapper.", + "type": "boolean" }, "formats": { + "default": [ + "standard" + ], "description": "Post formats supported.", - "type": "array", - "default": ["standard"], "items": { - "type": "string", "enum": { - "standard": "standard", "aside": "aside", + "audio": "audio", "chat": "chat", "gallery": "gallery", - "link": "link", "image": "image", + "link": "link", "quote": "quote", + "standard": "standard", "status": "status", - "video": "video", - "audio": "audio" - } - } + "video": "video" + }, + "type": "string" + }, + "type": "array" + }, + "html5": { + "default": false, + "description": "Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.", + "items": { + "enum": [ + "caption", + "comment-form", + "comment-list", + "gallery", + "script", + "search-form", + "style" + ], + "type": "string" + }, + "type": [ + "array", + "boolean" + ] }, "post-thumbnails": { - "description": "The post types that support thumbnails or true if all post types are supported.", - "type": ["boolean", "array"], "default": false, - "items": { "type": "string" } + "description": "The post types that support thumbnails or true if all post types are supported.", + "items": { + "type": "string" + }, + "type": [ + "array", + "boolean" + ] }, "responsive-embeds": { + "default": false, "description": "Whether the theme supports responsive embedded content.", - "type": "boolean", - "default": false + "type": "boolean" }, "title-tag": { + "default": false, "description": "Whether the theme can manage the document title tag.", - "type": "boolean", - "default": false + "type": "boolean" }, "wp-block-styles": { + "default": false, "description": "Whether theme opts in to default WordPress block styles for viewing.", - "type": "boolean", - "default": false + "type": "boolean" } - } + }, + "readonly": true, + "type": "object" }, "theme_uri": { "description": "The URI of the theme's webpage.", - "type": "object", - "readonly": true, "properties": { "raw": { "description": "The URI of the theme's webpage, as found in the theme header.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" }, "rendered": { "description": "The URI of the theme's webpage, transformed for display.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" } - } - }, - "version": { "description": "The theme's current version.", "type": "string", "readonly": true }, - "status": { "description": "A named status for the theme.", "type": "string", "enum": ["inactive", "active"] } - } - }, - "plugin": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "plugin", - "type": "object", - "properties": { - "plugin": { - "description": "The plugin file.", - "type": "string", - "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", + }, "readonly": true, - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "The plugin activation status.", - "type": "string", - "enum": ["inactive", "active"], - "context": ["view", "edit", "embed"] - }, - "name": { - "description": "The plugin name.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "plugin_uri": { - "description": "The plugin's website address.", - "type": "string", - "format": "uri", - "readonly": true, - "context": ["view", "edit"] - }, - "author": { - "description": "The plugin author.", - "type": "object", - "readonly": true, - "context": ["view", "edit"] - }, - "author_uri": { - "description": "The plugin author's website address.", - "type": "string", - "format": "uri", - "readonly": true, - "context": ["view", "edit"] - }, - "description": { - "description": "The plugin description.", - "type": "object", - "readonly": true, - "context": ["view", "edit"], - "properties": { - "raw": { "description": "The raw plugin description.", "type": "string" }, - "rendered": { "description": "The plugin description formatted for display.", "type": "string" } - } + "type": "object" }, "version": { - "description": "The plugin version number.", - "type": "string", + "description": "The theme's current version.", "readonly": true, - "context": ["view", "edit"] - }, - "network_only": { - "description": "Whether the plugin can only be activated network wide.", - "type": "boolean", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "requires_wp": { - "description": "Minimum required version of WordPress.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "requires_php": { - "description": "Minimum required version of PHP.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "textdomain": { - "description": "The plugin's text domain.", - "type": "string", - "readonly": true, - "context": ["view", "edit"] + "type": "string" } - } + }, + "title": "theme", + "type": "object" }, - "sidebar": { + "top_sellers_report": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "sidebar", - "type": "object", "properties": { - "id": { - "description": "ID of sidebar.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, "name": { - "description": "Unique name identifying the sidebar.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, + "quantity": { + "context": [ + "view" + ], + "description": "Total number of purchases.", + "readonly": true, + "type": "integer" + } + }, + "title": "top_sellers_report", + "type": "object" + }, + "type": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "capabilities": { + "context": [ + "edit" + ], + "description": "All capabilities used by the post type.", + "readonly": true, + "type": "object" }, "description": { - "description": "Description of sidebar.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "A human-readable description of the post type.", + "readonly": true, + "type": "string" }, - "class": { - "description": "Extra CSS class to assign to the sidebar in the Widgets interface.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "has_archive": { + "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": [ + "boolean", + "string" + ] }, - "before_widget": { - "description": "HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "hierarchical": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post type should have children.", + "readonly": true, + "type": "boolean" }, - "after_widget": { - "description": "HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "icon": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The icon for the post type.", + "readonly": true, + "type": [ + "null", + "string" + ] }, - "before_title": { - "description": "HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "labels": { + "context": [ + "edit" + ], + "description": "Human-readable labels for the post type for various contexts.", + "readonly": true, + "type": "object" }, - "after_title": { - "description": "HTML content to append to the sidebar title when displayed. Default is a closing h2 element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post type.", + "readonly": true, + "type": "string" + }, + "rest_base": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "REST base route for the post type.", + "readonly": true, + "type": "string" + }, + "rest_namespace": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "REST route's namespace for the post type.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post type.", + "readonly": true, + "type": "string" + }, + "supports": { + "context": [ + "edit" + ], + "description": "All features, supported by the post type.", + "readonly": true, + "type": "object" + }, + "taxonomies": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomies associated with post type.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "template": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The block template associated with the post type.", + "readonly": true, + "type": [ + "array" + ] + }, + "template_lock": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The template_lock associated with the post type, or false if none.", + "enum": [ + "all", + "insert", + "contentOnly", + false + ], + "readonly": true, + "type": [ + "boolean", + "string" + ] + }, + "viewable": { + "context": [ + "edit" + ], + "description": "Whether or not the post type can be viewed.", + "readonly": true, + "type": "boolean" + }, + "visibility": { + "context": [ + "edit" + ], + "description": "The visibility settings for the post type.", + "properties": { + "show_in_nav_menus": { + "description": "Whether to make the post type available for selection in navigation menus.", + "type": "boolean" + }, + "show_ui": { + "description": "Whether to generate a default UI for managing this post type.", + "type": "boolean" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "type", + "type": "object" + }, + "upload_theme": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "message": { + "context": [ + "edit", + "view" + ], + "description": "Theme installation message.", + "readonly": true, + "type": "string" }, "status": { - "description": "Status of sidebar.", - "type": "string", - "enum": ["active", "inactive"], - "context": ["embed", "view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "Theme installation status.", + "readonly": true, + "type": "string" }, - "widgets": { - "description": "Nested widgets.", - "type": "array", - "items": { "type": ["object", "string"] }, - "default": [], - "context": ["embed", "view", "edit"] + "theme": { + "context": [ + "edit", + "view" + ], + "description": "Uploaded theme.", + "readonly": true, + "type": "object" } - } + }, + "title": "upload_theme", + "type": "object" }, - "widget-type": { + "user": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "widget-type", - "type": "object", "properties": { - "id": { - "description": "Unique slug identifying the widget type.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "avatar_urls": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URLs for the user.", + "properties": { + "24": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 24 pixels.", + "format": "uri", + "type": "string" + }, + "48": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 48 pixels.", + "format": "uri", + "type": "string" + }, + "96": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 96 pixels.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" }, - "name": { - "description": "Human-readable name identifying the widget type.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "capabilities": { + "context": [ + "edit" + ], + "description": "All capabilities assigned to the user.", + "readonly": true, + "type": "object" }, "description": { - "description": "Description of the widget.", - "type": "string", - "default": "", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "embed", + "view" + ], + "description": "Description of the user.", + "type": "string" }, - "is_multi": { - "description": "Whether the widget supports multiple instances", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true + "email": { + "context": [ + "edit" + ], + "description": "The email address for the user.", + "format": "email", + "required": true, + "type": "string" }, - "classname": { - "description": "Class name", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "extra_capabilities": { + "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" + }, + "id": { + "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" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Author URL of the user.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "locale": { + "context": [ + "edit" + ], + "description": "Locale for the user.", + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "persisted_preferences": { + "additionalProperties": true, + "context": [ + "edit" + ], + "default": [], + "description": "", + "properties": { + "_modified": { + "description": "The date and time the preferences were updated.", + "format": "date-time", + "readonly": false, + "type": "string" + } + }, + "type": "object" + }, + "woocommerce_coming_soon_banner_dismissed": { + "default": "", + "description": "Indicate whether the user has dismissed the coming soon notice or not.", + "type": "string" + }, + "woocommerce_launch_your_store_tour_hidden": { + "default": "", + "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Display name 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).", + "required": true, + "type": "string" + }, + "registered_date": { + "context": [ + "edit" + ], + "description": "Registration date for the user.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "roles": { + "context": [ + "edit" + ], + "description": "Roles assigned to the user.", + "items": { + "type": "string" + }, + "type": "array" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the user.", + "format": "uri", + "type": "string" + }, + "username": { + "context": [ + "edit" + ], + "description": "Login name for the user.", + "required": true, + "type": "string" } - } + }, + "title": "user", + "type": "object" + }, + "webhook": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the webhook was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the webhook was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the webhook was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "delivery_url": { + "context": [ + "edit", + "view" + ], + "description": "The URL where the webhook payload is delivered.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "event": { + "context": [ + "edit", + "view" + ], + "description": "Webhook event.", + "readonly": true, + "type": "string" + }, + "hooks": { + "context": [ + "edit", + "view" + ], + "description": "WooCommerce action names associated with the webhook.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "A friendly name for the webhook.", + "type": "string" + }, + "resource": { + "context": [ + "edit", + "view" + ], + "description": "Webhook resource.", + "readonly": true, + "type": "string" + }, + "secret": { + "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": [ + "edit", + "view" + ], + "default": "active", + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "type": "string" + }, + "topic": { + "context": [ + "edit", + "view" + ], + "description": "Webhook topic.", + "type": "string" + } + }, + "title": "webhook", + "type": "object" + }, + "webhook_delivery": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_created": { + "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": [ + "edit", + "view" + ], + "description": "The date the webhook delivery was logged, as GMT.", + "readonly": true, + "type": "date-time" + }, + "duration": { + "context": [ + "view" + ], + "description": "The delivery duration, in seconds.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "request_body": { + "context": [ + "view" + ], + "description": "Request body", + "readonly": true, + "type": "string" + }, + "request_headers": { + "context": [ + "view" + ], + "description": "Request headers", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "request_url": { + "context": [ + "view" + ], + "description": "The URL where the webhook was delivered.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "response_body": { + "context": [ + "view" + ], + "description": "The response body from the receiving server.", + "readonly": true, + "type": "string" + }, + "response_code": { + "context": [ + "view" + ], + "description": "The HTTP response code from the receiving server.", + "readonly": true, + "type": "string" + }, + "response_headers": { + "context": [ + "view" + ], + "description": "Array of the response headers from the receiving server.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "response_message": { + "context": [ + "view" + ], + "description": "The HTTP response message from the receiving server.", + "readonly": true, + "type": "string" + }, + "summary": { + "context": [ + "view" + ], + "description": "A friendly summary of the response including the HTTP response code, message, and body.", + "readonly": true, + "type": "string" + } + }, + "title": "webhook_delivery", + "type": "object" }, "widget": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "widget", - "type": "object", "properties": { + "form_data": { + "context": [], + "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": { + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the widget.", - "type": "string", - "context": ["view", "edit", "embed"] + "type": "string" }, "id_base": { + "context": [ + "edit", + "embed", + "view" + ], "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "sidebar": { - "description": "The sidebar to which the widget belongs.", - "type": "string", - "default": "wp_inactive_widgets", - "required": true, - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML representation of the widget.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "rendered_form": { - "description": "HTML representation of the widget admin form.", - "type": "string", - "context": ["edit"], - "readonly": true + "type": "string" }, "instance": { - "description": "Instance settings of the widget, if supported.", - "type": "object", - "context": ["edit"], + "context": [ + "edit" + ], "default": null, + "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { + "context": [ + "edit" + ], "description": "Base64 encoded representation of the instance settings.", - "type": "string", - "context": ["edit"] + "type": "string" }, "hash": { + "context": [ + "edit" + ], "description": "Cryptographic hash of the instance settings.", - "type": "string", - "context": ["edit"] + "type": "string" }, "raw": { + "context": [ + "edit" + ], "description": "Unencoded instance settings, if supported.", - "type": "object", - "context": ["edit"] + "type": "object" } - } + }, + "type": "object" }, - "form_data": { - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", - "type": "string", - "context": [] + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML representation of the widget.", + "readonly": true, + "type": "string" + }, + "rendered_form": { + "context": [ + "edit" + ], + "description": "HTML representation of the widget admin form.", + "readonly": true, + "type": "string" + }, + "sidebar": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "wp_inactive_widgets", + "description": "The sidebar to which the widget belongs.", + "required": true, + "type": "string" } - } + }, + "title": "widget", + "type": "object" }, - "block-directory-item": { + "widget-type": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-directory-item", - "type": "object", "properties": { - "name": { - "description": "The block name, in namespace/block-name format.", - "type": "string", - "context": ["view"] - }, - "title": { - "description": "The block title, in human readable format.", - "type": "string", - "context": ["view"] + "classname": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Class name", + "readonly": true, + "type": "string" }, "description": { - "description": "A short description of the block, in human readable format.", - "type": "string", - "context": ["view"] + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of the widget.", + "type": "string" }, - "id": { "description": "The block slug.", "type": "string", "context": ["view"] }, - "rating": { "description": "The star rating of the block.", "type": "number", "context": ["view"] }, - "rating_count": { "description": "The number of ratings.", "type": "integer", "context": ["view"] }, - "active_installs": { - "description": "The number of sites that have activated this block.", - "type": "integer", - "context": ["view"] - }, - "author_block_rating": { - "description": "The average rating of blocks published by the same author.", - "type": "number", - "context": ["view"] - }, - "author_block_count": { - "description": "The number of blocks published by the same author.", - "type": "integer", - "context": ["view"] - }, - "author": { - "description": "The WordPress.org username of the block author.", - "type": "string", - "context": ["view"] - }, - "icon": { "description": "The block icon.", "type": "string", "format": "uri", "context": ["view"] }, - "last_updated": { - "description": "The date when the block was last updated.", - "type": "string", - "format": "date-time", - "context": ["view"] - }, - "humanized_updated": { - "description": "The date when the block was last updated, in fuzzy human readable format.", - "type": "string", - "context": ["view"] - } - } - }, - "pattern-directory-item": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "pattern-directory-item", - "type": "object", - "properties": { "id": { - "description": "The pattern ID.", - "type": "integer", - "minimum": 1, - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The pattern title, in human readable format.", - "type": "string", - "minLength": 1, - "context": ["view", "edit", "embed"] - }, - "content": { - "description": "The pattern content.", - "type": "string", - "minLength": 1, - "context": ["view", "edit", "embed"] - }, - "categories": { - "description": "The pattern's category slugs.", - "type": "array", - "uniqueItems": true, - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "keywords": { - "description": "The pattern's keywords.", - "type": "array", - "uniqueItems": true, - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "A description of the pattern.", - "type": "string", - "minLength": 1, - "context": ["view", "edit", "embed"] - }, - "viewport_width": { - "description": "The preferred width of the viewport when previewing a pattern, in pixels.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "block_types": { - "description": "The block types which can use this pattern.", - "type": "array", - "uniqueItems": true, - "items": { "type": "string" }, - "context": ["view", "embed"] - } - } - }, - "block-pattern": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-pattern", - "type": "object", - "properties": { - "name": { - "description": "The pattern name.", - "type": "string", + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique slug identifying the widget type.", "readonly": true, - "context": ["view", "edit", "embed"] + "type": "string" }, - "title": { - "description": "The pattern title, in human readable format.", - "type": "string", + "is_multi": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the widget supports multiple instances", "readonly": true, - "context": ["view", "edit", "embed"] - }, - "content": { - "description": "The pattern content.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The pattern detailed description.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "viewport_width": { - "description": "The pattern viewport width for inserter preview.", - "type": "number", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "inserter": { - "description": "Determines whether the pattern is visible in inserter.", - "type": "boolean", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "categories": { - "description": "The pattern's category slugs.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "keywords": { - "description": "The pattern keywords.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "block_types": { - "description": "Block types that the pattern is intended to be used with.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "post_types": { - "description": "An array of post types that the pattern is restricted to be used with.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "template_types": { - "description": "An array of template types where the pattern fits.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "source": { - "description": "Where the pattern comes from e.g. core", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"], - "enum": [ - "core", - "plugin", - "theme", - "pattern-directory/core", - "pattern-directory/theme", - "pattern-directory/featured" - ] - } - } - }, - "block-pattern-category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-pattern-category", - "type": "object", - "properties": { - "name": { - "description": "The category name.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "label": { - "description": "The category label, in human readable format.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The category description in a human-readable format.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - } - } - }, - "menu-location": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "menu-location", - "type": "object", - "properties": { - "name": { - "description": "The name of the menu location.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "description": { - "description": "The description of the menu location.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "menu": { - "description": "The ID of the assigned menu.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - } - } - }, - "font-collection": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "font-collection", - "type": "object", - "properties": { - "slug": { - "description": "Unique identifier for the font collection.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "type": "boolean" }, "name": { - "description": "The name for the font collection.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The description for the font collection.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "font_families": { - "description": "The font families for the font collection.", - "type": "array", - "context": ["view", "edit", "embed"] - }, - "categories": { - "description": "The categories for the font collection.", - "type": "array", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Human-readable name identifying the widget type.", + "readonly": true, + "type": "string" } - } + }, + "title": "widget-type", + "type": "object" }, "wp-site-health-test": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp-site-health-test", - "type": "object", "properties": { - "test": { "type": "string", "description": "The name of the test being run.", "readonly": true }, - "label": { "type": "string", "description": "A label describing the test.", "readonly": true }, - "status": { - "type": "string", - "description": "The status of the test.", - "enum": ["good", "recommended", "critical"], - "readonly": true + "actions": { + "description": "HTML containing an action to direct the user to where they can resolve the issue.", + "readonly": true, + "type": "string" }, "badge": { - "type": "object", "description": "The category this test is grouped in.", "properties": { - "label": { "type": "string", "readonly": true }, "color": { - "type": "string", - "enum": ["blue", "orange", "red", "green", "purple", "gray"], - "readonly": true + "enum": [ + "blue", + "gray", + "green", + "orange", + "purple", + "red" + ], + "readonly": true, + "type": "string" + }, + "label": { + "readonly": true, + "type": "string" } }, - "readonly": true + "readonly": true, + "type": "object" }, "description": { - "type": "string", "description": "A more descriptive explanation of what the test looks for, and why it is important for the user.", - "readonly": true + "readonly": true, + "type": "string" }, - "actions": { - "type": "string", - "description": "HTML containing an action to direct the user to where they can resolve the issue.", - "readonly": true + "label": { + "description": "A label describing the test.", + "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" }, - "navigation-fallback": { + "wp_block": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the wp_pattern_category taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the wp_pattern_category taxonomy." + } + ], + "properties": { + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, + "wp_pattern_sync_status": { + "default": "", + "description": "", + "enum": [ + "partial", + "unsynced" + ], + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + }, + "wp_pattern_category": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "wp_block", + "type": "object" + }, + "wp_block-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, + "wp_pattern_sync_status": { + "default": "", + "description": "", + "enum": [ + "partial", + "unsynced" + ], + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + } + }, + "title": "wp_block-revision", + "type": "object" + }, + "wp_font_face": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "font_face_settings": { + "additionalProperties": false, + "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" + }, + "fontDisplay": { + "default": "fallback", + "description": "CSS font-display value.", + "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" + }, + "fontWeight": { + "default": "400", + "description": "List of available font weights, separated by a space.", + "type": [ + "integer", + "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" + }, + "src": { + "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" + } + }, + "required": [ + "fontFamily", + "src" + ], + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent font family of the font face.", + "type": "integer" + }, + "theme_json_version": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 3, + "description": "Version of the theme.json schema used for the typography settings.", + "maximum": 3, + "minimum": 2, + "type": "integer" + } + }, + "title": "wp_font_face", + "type": "object" + }, + "wp_font_family": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "font_faces": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The IDs of the child font faces in the font family.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "font_family_settings": { + "additionalProperties": false, + "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" + }, + "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" + } + }, + "required": [ + "fontFamily", + "name", + "slug" + ], + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "theme_json_version": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 3, + "description": "Version of the theme.json schema used for the typography settings.", + "maximum": 3, + "minimum": 2, + "type": "integer" + } + }, + "title": "wp_font_family", + "type": "object" + }, + "wp_global_styles": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "navigation-fallback", - "type": "object", "properties": { "id": { - "description": "The unique identifier for the Navigation Menu.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of global styles config.", + "readonly": true, + "type": "string" + }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "context": [ + "edit", + "view" + ], + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of the global styles variation.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the global styles variation, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] } - } + }, + "title": "wp_global_styles", + "type": "object" + }, + "wp_global_styles-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of global styles config.", + "readonly": true, + "type": "string" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "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" + }, + "wp_navigation": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "title": "The current user can post unfiltered HTML markup and JavaScript." + } + ], + "properties": { + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit", + "embed" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "wp_navigation", + "type": "object" + }, + "wp_navigation-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit", + "embed" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "wp_navigation-revision", + "type": "object" + }, + "wp_pattern_category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "wp_pattern_category" + ], + "readonly": true, + "type": "string" + } + }, + "title": "wp_pattern_category", + "type": "object" + }, + "wp_template": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the template.", + "type": "integer" + }, + "author_text": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Human readable text for the author.", + "readonly": true, + "type": "string" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of template.", + "type": "string" + }, + "has_theme_file": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme file exists.", + "readonly": true, + "type": "bool" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of template.", + "readonly": true, + "type": "string" + }, + "is_custom": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether a template is a custom template.", + "readonly": true, + "type": "bool" + }, + "modified": { + "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": [ + "edit", + "embed", + "view" + ], + "description": "Source of a customised template", + "readonly": true, + "type": "string" + }, + "original_source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "From where the template originally comes, eg 'theme'", + "enum": [ + "plugin", + "site", + "theme", + "user" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": true, + "type": "string" + }, + "source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Source of template", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "publish", + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "theme": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" + }, + "wp_id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Post ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "wp_template", + "type": "object" + }, + "wp_template_part": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "area": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Where the template part is intended for use (header, footer, etc)", + "type": "string" + }, + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the template.", + "type": "integer" + }, + "author_text": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Human readable text for the author.", + "readonly": true, + "type": "string" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of template.", + "type": "string" + }, + "has_theme_file": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme file exists.", + "readonly": true, + "type": "bool" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of template.", + "readonly": true, + "type": "string" + }, + "modified": { + "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": [ + "edit", + "embed", + "view" + ], + "description": "Source of a customised template", + "readonly": true, + "type": "string" + }, + "original_source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "From where the template originally comes, eg 'theme'", + "enum": [ + "plugin", + "site", + "theme", + "user" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": true, + "type": "string" + }, + "source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Source of template", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "publish", + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "theme": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" + }, + "wp_id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Post ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "wp_template_part", + "type": "object" } } }, + "info": { + "contact": { + "email": "contact@gcch.fr", + "name": "Haiku Atelier", + "url": "https:/haikuatelier.fr.ddev.site" + }, + "description": "", + "title": "Haiku Atelier API", + "version": "6.6.1" + }, + "openapi": "3.1.0", "paths": { - "/wc/v3": { + "/carbon-fields/v1": { "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/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/connect": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_key": { "type": "string", "required": true } }, - "required": ["product_key"] - } - } - } - } - } - }, - "/wc/v3/marketplace/subscriptions/disconnect": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_key": { "type": "string", "required": true } }, - "required": ["product_key"] - } - } - } - } - } - }, - "/wc/v3/marketplace/subscriptions/activate": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_key": { "type": "string", "required": true } }, - "required": ["product_key"] - } - } - } - } - } - }, - "/wc/v3/marketplace/subscriptions/install-url": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "product_key", "in": "query", "description": "", "required": true, "schema": {} }] - } - }, - "/wc/v3/marketplace/create-order": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_id": { "required": true } }, - "required": ["product_id"] - } - } - } - } - } - }, - "/wc/v3/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, "parameters": [ { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "code", - "in": "query", - "description": "Limit result set to resources with a specific code.", "required": false, "schema": {} } - ] - }, - "post": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["code"] - } - } + "description": "OK" } } } }, - "/wc/v3/coupons/{id}": { + "/carbon-fields/v1/association": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } + "description": "OK" } } } }, - "/wc/v3/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/customers/{customer_id}/downloads": { + "/carbon-fields/v1/association/options": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } } + "description": "OK" } - }, - "parameters": [ - { - "name": "customer_id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] + } } }, - "/wc/v3/customers": { + "/carbon-fields/v1/attachment": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, "parameters": [ { - "name": "context", + "description": "The requested type: ID or URL.", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } - }, - { - "name": "email", - "in": "query", - "description": "Limit result set to resources with a specific email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "role", - "in": "query", - "description": "Limit result set to resources with a specific role.", - "required": false, - "schema": { - "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "required": true, "description": "New user email address." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "required": false, "description": "New user username." }, - "password": { "type": "string", "required": true, "description": "New user password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["email", "password"] - } - } - } - } - } - }, - "/wc/v3/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - }, - "reassign": { "type": "integer", "description": "ID to reassign posts to." } - } - } - } - } - } - } - }, - "/wc/v3/customers/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/layout-templates": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "area", - "in": "query", - "description": "Area to get templates for.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/v3/layout-templates/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/v3/orders/{order_id}/notes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { "name": "type", + "required": true, + "schema": {} + }, + { + "description": "The ID / URL of the attachment", "in": "query", - "description": "Limit result to customers or internal notes.", - "required": false, - "schema": { "enum": ["any", "customer", "internal"] } + "name": "value", + "required": true, + "schema": {} } - ] - }, + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/block-renderer": { "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "note": { "type": "string", "required": true, "description": "Order note content." }, - "customer_note": { - "type": "boolean", - "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." - }, - "added_by_user": { - "type": "boolean", - "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system." - } - }, - "required": ["note"] - } - } - } - } - } - }, - "/wc/v3/orders/{order_id}/notes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/orders/{order_id}/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "amount": { "type": "string", "description": "Refund amount." }, - "reason": { "type": "string", "description": "Reason for refund." }, - "refunded_by": { "type": "integer", "description": "User ID of user who created the refund." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "api_refund": { - "type": "boolean", - "description": "When true, the payment gateway API is used to generate the refund." - }, - "api_restock": { "type": "boolean", "description": "When true, refunded items are restocked." } - } - } - } - } - } - } - }, - "/wc/v3/orders/{order_id}/refunds/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders which have specific statuses.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": [ - "any", - "trash", - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ] - } - } - }, - { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - } - }, - "/wc/v3/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - } - }, - "/wc/v3/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products/custom-fields/names": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": {} - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort items ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - } - ] - } - }, - "/wc/v3/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to reviews published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } - }, - { - "name": "reviewer", - "in": "query", - "description": "Limit result set to reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_exclude", - "in": "query", - "description": "Ensure result set excludes reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_email", - "in": "query", - "description": "Limit result set to that from a specific author email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to reviews assigned to specific product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to reviews assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", + "content": { + "description": "The content of the block.", "required": true, - "description": "Unique identifier for the product." + "type": "string" }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "reviewer_email": { "type": "string", "required": true, "description": "Email of the reviewer." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "name": { + "description": "The name of the block.", + "required": true, + "type": "string" + }, + "post_id": { + "description": "ID of the post context.", + "type": "integer" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"] + "required": [ + "content", + "name" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } } } }, - "/wc/v3/products/reviews/{id}": { + "/carbon-fields/v1/comments/{id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/options": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/products/reviews/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes/slug-suggestion": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { "name": "name", "in": "query", "description": "Shipping class name.", "required": false, "schema": {} }, - { - "name": "slug", - "in": "query", - "description": "An alphanumeric identifier for the resource unique to its type.", - "required": false, - "schema": {} - }, - { - "name": "description", - "in": "query", - "description": "HTML description of the resource.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/v3/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/tags/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order", - "price", - "popularity", - "rating" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "search_sku", - "in": "query", - "description": "Limit results to those with a SKU that partially matches a string.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/suggested-products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "in_stock", - "in": "query", - "description": "Limit result set to products in stock or out of stock.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result set to specific product categorie ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tags", - "in": "query", - "description": "Limit result set to specific product tag ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "limit", - "in": "query", - "description": "Limit result set to specific amount of suggested products.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/v3/products/{id}/duplicate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "has_price", - "in": "query", - "description": "Limit result set to products with or without price.", - "required": false, - "schema": {} - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with specified attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { "type": "string", "description": "Attribute slug." }, - "term": { "type": "string", "description": "Attribute term." }, - "terms": { "type": "array", "description": "Attribute terms." } - } - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations/generate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "delete": { "type": "boolean", "description": "Deletes unused variations." }, - "default_values": { "type": "object", "description": "Default values for generated variations." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc/v3/reports/sales": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v3/reports/top_sellers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v3/reports/orders/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_order_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/products/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_product_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/customers/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customer_total" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/coupons/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupon_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/reviews/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_review_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/settings": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } } - } - } - } - }, - "/wc/v3/settings/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - } - } - }, - "/wc/v3/settings/{group_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/v3/settings/{group_id}/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - } - }, - "/wc/v3/settings/{group_id}/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - } - }, - "/wc/v3/shipping/zones": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } + "description": "OK" } } }, "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - }, - "required": ["name"] - } - } + "description": "OK" } } } }, - "/wc/v3/shipping/zones/{id}": { + "/carbon-fields/v1/posts/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/shipping/zones/{id}/locations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } - } - } - } - }, - "/wc/v3/shipping/zones/{zone_id}/methods": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." }, - "method_id": { "required": true, "description": "Shipping method ID." } - }, - "required": ["method_id"] - } - } - } - } - } - }, - "/wc/v3/shipping/zones/{zone_id}/methods/{instance_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, { - "name": "instance_id", + "description": "", "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/taxes/classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "name": { "type": "string", "required": true, "description": "Tax class name." } }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/taxes/classes/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "order", "priority"] } - }, - { - "name": "class", - "in": "query", - "description": "Sort by tax class.", - "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc/v3/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } + "description": "OK" } - }, + } + } + }, + "/carbon-fields/v1/terms/{id}": { + "get": { "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "patch": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } + "description": "OK" } - }, + } + } + }, + "/carbon-fields/v1/users/{id}": { + "get": { "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } + "responses": { + "200": { + "description": "OK" } } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc/v3/webhooks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "title"] } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to webhooks assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "required": true, "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - }, - "delivery_url": { "type": "string", "required": true, "description": "Webhook delivery URL." } - }, - "required": ["topic", "delivery_url"] - } - } - } - } - } - }, - "/wc/v3/webhooks/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/webhooks/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - } - }, - "/wc/v3/system_status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/system_status/tools": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v3/system_status/tools/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - } - }, - "/wc/v3/shipping_methods": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/shipping_methods/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/payment_gateways": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v3/payment_gateways/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } - } - } - } - } - } - }, - "/wc/v3/data": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc/v3/data/continents": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } } - } - } - } - }, - "/wc/v3/data/continents/{location}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } } - } - }, - "parameters": [ - { - "name": "continent", - "in": "query", - "description": "2 character continent code.", - "required": false, - "schema": {} - }, - { "name": "location", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/v3/data/countries": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } - } - } - } - }, - "/wc/v3/data/countries/{location}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } - } - }, - "parameters": [ - { - "name": "location", - "in": "path", - "description": "ISO3166 alpha-2 country code.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/v3/data/currencies": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } } - } - } - } - }, - "/wc/v3/data/currencies/current": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } } - } - } - } - }, - "/wc/v3/data/currencies/{currency}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } } - } - }, - "parameters": [ - { - "name": "location", - "in": "query", - "description": "ISO4217 currency code.", - "required": false, - "schema": {} - }, - { "name": "currency", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/v3/orders/{id}/receipt": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier of the order.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "expiration_date": { "type": "string", "description": "Expiration date formatted as dd-mm-yyyy." }, - "expiration_days": { - "type": "integer", - "description": "Number of days to be added to the current date to get the expiration date." - }, - "force_new": { - "type": "boolean", - "required": false, - "description": "True to force the creation of a new receipt even if one already exists and has not expired yet." - } - } - } - } - } - } - }, - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier of the order.", - "required": true, - "schema": {} - } - ] - } - }, - "/wp-openapi/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp-openapi/v1/schema": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }] } }, "/jetpack/v4": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/jetpack/v4/verify_xmlrpc_error": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "nonce": { "type": "string", "required": true } }, - "required": ["nonce"] - } - } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" } } } }, - "/jetpack/v4/verify_registration": { - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } }, - "patch": { "responses": { "200": { "description": "OK" } } } - }, - "/jetpack/v4/remote_authorize": { - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } }, - "patch": { "responses": { "200": { "description": "OK" } } } - }, "/jetpack/v4/connection": { - "get": { "responses": { "200": { "description": "OK" } } }, - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "isActive": { "required": true, "description": "Set to false will trigger the site to disconnect." } - }, - "required": ["isActive"] - } - } - } - } - }, - "put": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "isActive": { "required": true, "description": "Set to false will trigger the site to disconnect." } - }, - "required": ["isActive"] - } - } + "get": { + "responses": { + "200": { + "description": "OK" } } }, "patch": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "isActive": { "required": true, "description": "Set to false will trigger the site to disconnect." } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"] + "required": [ + "isActive" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } } - } - }, - "/jetpack/v4/connection/data": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/jetpack/v4/connection/plugins": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/jetpack/v4/connection/reconnect": { - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } }, - "patch": { "responses": { "200": { "description": "OK" } } } - }, - "/jetpack/v4/connection/register": { + }, "post": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "from": { - "type": "string", - "description": "Indicates where the registration action was triggered for tracking/segmentation purposes" - }, - "registration_nonce": { "type": "string", "required": true, "description": "The registration nonce" }, - "redirect_uri": { - "type": "string", - "description": "URI of the admin page where the user should be redirected after connection flow" - }, - "plugin_slug": { - "type": "string", - "description": "Indicates from what plugin the request is coming from" + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true } }, - "required": ["registration_nonce"] + "required": [ + "isActive" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } } }, "put": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "from": { - "type": "string", - "description": "Indicates where the registration action was triggered for tracking/segmentation purposes" - }, - "registration_nonce": { "type": "string", "required": true, "description": "The registration nonce" }, - "redirect_uri": { - "type": "string", - "description": "URI of the admin page where the user should be redirected after connection flow" - }, - "plugin_slug": { - "type": "string", - "description": "Indicates from what plugin the request is coming from" + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true } }, - "required": ["registration_nonce"] + "required": [ + "isActive" + ], + "type": "object" } } } - } - }, - "patch": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "from": { - "type": "string", - "description": "Indicates where the registration action was triggered for tracking/segmentation purposes" - }, - "registration_nonce": { "type": "string", "required": true, "description": "The registration nonce" }, - "redirect_uri": { - "type": "string", - "description": "URI of the admin page where the user should be redirected after connection flow" - }, - "plugin_slug": { - "type": "string", - "description": "Indicates from what plugin the request is coming from" - } - }, - "required": ["registration_nonce"] - } - } + }, + "responses": { + "200": { + "description": "OK" } } } }, "/jetpack/v4/connection/authorize_url": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ { - "name": "redirect_uri", - "in": "query", "description": "URI of the admin page where the user should be redirected after connection flow", + "in": "query", + "name": "redirect_uri", "required": false, "schema": {} } - ] + ], + "responses": { + "200": { + "description": "OK" + } + } } }, - "/jetpack/v4/user-token": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "user_token": { "type": "string", "required": true, "description": "New user token" }, - "is_connection_owner": { "type": "boolean", "description": "Is connection owner" } - }, - "required": ["user_token"] - } - } - } - } - }, - "put": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "user_token": { "type": "string", "required": true, "description": "New user token" }, - "is_connection_owner": { "type": "boolean", "description": "Is connection owner" } - }, - "required": ["user_token"] - } - } - } - } - }, - "patch": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "user_token": { "type": "string", "required": true, "description": "New user token" }, - "is_connection_owner": { "type": "boolean", "description": "Is connection owner" } - }, - "required": ["user_token"] - } - } + "/jetpack/v4/connection/data": { + "get": { + "responses": { + "200": { + "description": "OK" } } } }, "/jetpack/v4/connection/owner": { - "post": { - "responses": { "200": { "description": "OK" } }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "owner": { "type": "integer", "required": true, "description": "New owner" } }, - "required": ["owner"] + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } } }, "put": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "owner": { "type": "integer", "required": true, "description": "New owner" } }, - "required": ["owner"] + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], + "type": "object" } } } + }, + "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" + } + } + } + }, + "/jetpack/v4/connection/register": { "patch": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "owner": { "type": "integer", "required": true, "description": "New owner" } }, - "required": ["owner"] + "properties": { + "from": { + "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", + "type": "string" + }, + "plugin_slug": { + "description": "Indicates from what plugin the request is coming from", + "type": "string" + }, + "redirect_uri": { + "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" + } + }, + "required": [ + "registration_nonce" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "from": { + "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", + "type": "string" + }, + "plugin_slug": { + "description": "Indicates from what plugin the request is coming from", + "type": "string" + }, + "redirect_uri": { + "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" + } + }, + "required": [ + "registration_nonce" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "from": { + "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", + "type": "string" + }, + "plugin_slug": { + "description": "Indicates from what plugin the request is coming from", + "type": "string" + }, + "redirect_uri": { + "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" + } + }, + "required": [ + "registration_nonce" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/remote_authorize": { + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/user-token": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "user_token" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "user_token" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "user_token" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/verify_registration": { + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/verify_xmlrpc_error": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "nonce": { + "required": true, + "type": "string" + } + }, + "required": [ + "nonce" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } } } }, "/wc-admin": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc-admin/notice/dismiss": { "post": { "responses": { "200": { "description": "OK" } } } }, - "/wc-admin/features": { - "get": { + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "description": "OK" } } } @@ -25645,98 +26190,324 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } }, - "/wc-admin/marketing/recommended": { + "/wc-admin/features": { "get": { "responses": { "200": { - "description": "OK", - "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" + } + } + } + }, + "/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" + } + } } }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/launch-your-store/woopayments/test-orders": { + "delete": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/launch-your-store/woopayments/test-orders/count": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/marketing/campaign-types": { + "get": { "parameters": [ { - "name": "per_page", + "description": "Scope under which the request is made; determines fields present in response.", "in": "query", - "description": "Maximum number of items to be returned in result set.", + "name": "context", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "enum": [ + "view" + ] + } }, - { "name": "category", "in": "query", "description": "", "required": false, "schema": {} } - ] + { + "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 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign_type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/marketing/campaigns": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "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 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/marketing/channels": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_channel" + } + } + }, + "description": "OK" + } + } } }, "/wc-admin/marketing/knowledge-base": { "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "category", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "category", "in": "query", "description": "", "required": false, "schema": {} }] + } } }, "/wc-admin/marketing/overview/activate-plugin": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "plugin": { "type": "string", "required": true } }, - "required": ["plugin"] + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "plugin": { "type": "string", "required": true } }, - "required": ["plugin"] + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], + "type": "object" } } } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "plugin": { "type": "string", "required": true } }, - "required": ["plugin"] + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } } - } + }, + "description": "OK" } } } @@ -25745,1148 +26516,79 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } }, "/wc-admin/marketing/recommendations": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_recommendation" } } - } - } - }, "parameters": [ { - "name": "category", - "in": "query", "description": "", + "in": "query", + "name": "category", "required": true, - "schema": { "enum": ["channels", "extensions"] } + "schema": { + "enum": [ + "channels", + "extensions" + ] + } } - ] - } - }, - "/wc-admin/marketing/channels": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_channel" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_recommendation" + } + } + }, + "description": "OK" } } } }, - "/wc-admin/marketing/campaigns": { + "/wc-admin/marketing/recommended": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - } - ] - } - }, - "/wc-admin/marketing/campaign-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign_type" } } - } - } - }, - "parameters": [ - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", "required": false, - "schema": { "minimum": 1, "maximum": 100 } - } - ] - } - }, - "/wc-admin/options": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - } - }, - "/wc-admin/payment-gateway-suggestions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } + "schema": { + "maximum": 100, + "minimum": 1 } - } - }, - "parameters": [ - { - "name": "force_default_suggestions", - "in": "query", - "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-admin/payment-gateway-suggestions/dismiss": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } - } - } - } - } - }, - "/wc-admin/themes": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "pluginzip": { "type": "file", "description": "A zip file of the theme to be uploaded." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "pluginzip": { "type": "file", "description": "A zip file of the theme to be uploaded." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "pluginzip": { "type": "file", "description": "A zip file of the theme to be uploaded." } - } - } - } - } - } - } - }, - "/wc-admin/plugins/install": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/install/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/install/status/{job_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - }, - "parameters": [{ "name": "job_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/plugins/active": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/installed": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/activate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/activate/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/activate/status/{job_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - }, - "parameters": [{ "name": "job_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/plugins/connect-jetpack": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/request-wccom-connect": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/finish-wccom-connect": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/connect-wcpay": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/connect-square": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/onboarding/free-extensions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/product-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/profile": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "completed": { "type": "boolean", "description": "Whether or not the profile was completed." }, - "skipped": { "type": "boolean", "description": "Whether or not the profile was skipped." }, - "industry": { "type": "array", "description": "Industry." }, - "product_types": { "type": "array", "description": "Types of products sold." }, - "product_count": { "type": "string", "description": "Number of products to be added." }, - "selling_venues": { "type": "string", "description": "Other places the store is selling products." }, - "number_employees": { "type": "string", "description": "Number of employees of the store." }, - "revenue": { "type": "string", "description": "Current annual revenue of the store." }, - "other_platform": { "type": "string", "description": "Name of other platform used to sell." }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed)." - }, - "business_extensions": { "type": "array", "description": "Extra business extensions to install." }, - "theme": { "type": "string", "description": "Selected store theme." }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client." - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow." - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com." - }, - "store_email": { "type": "string", "description": "Store email address." }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler." - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped." - }, - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "completed": { "type": "boolean", "description": "Whether or not the profile was completed." }, - "skipped": { "type": "boolean", "description": "Whether or not the profile was skipped." }, - "industry": { "type": "array", "description": "Industry." }, - "product_types": { "type": "array", "description": "Types of products sold." }, - "product_count": { "type": "string", "description": "Number of products to be added." }, - "selling_venues": { "type": "string", "description": "Other places the store is selling products." }, - "number_employees": { "type": "string", "description": "Number of employees of the store." }, - "revenue": { "type": "string", "description": "Current annual revenue of the store." }, - "other_platform": { "type": "string", "description": "Name of other platform used to sell." }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed)." - }, - "business_extensions": { "type": "array", "description": "Extra business extensions to install." }, - "theme": { "type": "string", "description": "Selected store theme." }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client." - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow." - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com." - }, - "store_email": { "type": "string", "description": "Store email address." }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler." - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped." - }, - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "completed": { "type": "boolean", "description": "Whether or not the profile was completed." }, - "skipped": { "type": "boolean", "description": "Whether or not the profile was skipped." }, - "industry": { "type": "array", "description": "Industry." }, - "product_types": { "type": "array", "description": "Types of products sold." }, - "product_count": { "type": "string", "description": "Number of products to be added." }, - "selling_venues": { "type": "string", "description": "Other places the store is selling products." }, - "number_employees": { "type": "string", "description": "Number of employees of the store." }, - "revenue": { "type": "string", "description": "Current annual revenue of the store." }, - "other_platform": { "type": "string", "description": "Name of other platform used to sell." }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed)." - }, - "business_extensions": { "type": "array", "description": "Extra business extensions to install." }, - "theme": { "type": "string", "description": "Selected store theme." }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client." - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow." - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com." - }, - "store_email": { "type": "string", "description": "Store email address." }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler." - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped." - }, - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - } - }, - "/wc-admin/onboarding/profile/experimental_get_email_prefill": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - } - } - }, - "/wc-admin/onboarding/tasks/import_sample_products": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/tasks/create_homepage": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/tasks/create_product_from_template": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "template_name": { "type": "string", "required": true, "description": "Product template name." } - }, - "required": ["template_name"] - } - } - } - } - } - }, - "/wc-admin/onboarding/tasks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [ - { - "name": "ids", - "in": "query", - "description": "Optional parameter to get only specific task lists by ID.", - "required": false, - "schema": { "items": { "enum": ["setup", "extended", "secret_tasklist"], "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "ids": { - "type": "array", - "description": "Optional parameter to get only specific task lists by ID." - }, - "extended_tasks": { - "type": "array", - "description": "List of extended deprecated tasks from the client-side filter." - } - } - } - } - } - } - } - }, - "/wc-admin/onboarding/tasks/{id}/hide": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/unhide": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/dismiss": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/undo_dismiss": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/snooze": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "duration": { "type": "string", "description": "Time period to snooze the task." }, - "task_list_id": { "type": "string", "description": "Optional parameter to query specific task list." } - } - } - } - } - } - } - }, - "/wc-admin/onboarding/tasks/{id}/action": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/undo_snooze": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/themes/install": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - } - }, - "/wc-admin/onboarding/themes/activate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - } - }, - "/wc-admin/onboarding/themes/recommended": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "industry", - "in": "query", - "description": "Limits the results to themes relevant for this industry (optional)", - "required": false, - "schema": {} }, { - "name": "currency", + "description": "", "in": "query", - "description": "Returns pricing in this currency (optional, default: USD)", + "name": "category", "required": false, - "schema": { "enum": ["USD", "AUD", "CAD", "EUR", "GBP"] } + "schema": {} } - ] - } - }, - "/wc-admin/onboarding/plugins/install-and-activate-async": { - "post": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "plugins": { "type": "array", "required": true, "description": "A list of plugins to install" } - }, - "required": ["plugins"] - } - } - } - } - } - }, - "/wc-admin/onboarding/plugins/install-and-activate": { - "post": { - "responses": { - "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Install and Activate Schema" } } - } - } - } - } - }, - "/wc-admin/onboarding/plugins/scheduled-installs/{job_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } } - } - }, - "parameters": [{ "name": "job_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/plugins/jetpack-authorization-url": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "redirect_url", - "in": "query", - "description": "The URL to redirect to after authorization", - "required": true, - "schema": {} - }, - { - "name": "from", - "in": "query", - "description": "from value for the jetpack authorization page", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-admin/onboarding/products": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/navigation/favorites/me": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "item_id": { "required": true } }, "required": ["item_id"] } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "item_id": { "required": true } }, "required": ["item_id"] } - } - } - } - } - }, - "/wc-admin/mobile-app/send-magic-link": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } @@ -26895,4775 +26597,4288 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/mobile-app/send-magic-link": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/navigation/favorites/me": { + "delete": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "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" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/install-and-activate": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install and Activate Schema" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/install-and-activate-async": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "plugins": { + "description": "A list of plugins to install", + "required": true, + "type": "array" + } + }, + "required": [ + "plugins" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/jetpack-authorization-url": { + "get": { + "parameters": [ + { + "description": "The URL to redirect to after authorization", + "in": "query", + "name": "redirect_url", + "required": true, + "schema": {} + }, + { + "description": "from value for the jetpack authorization page", + "in": "query", + "name": "from", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/scheduled-installs/{job_id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/product-types": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/products": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/profile": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "requestBody": { + "content": { + "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" + }, + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "industry": { + "description": "Industry.", + "type": "array" + }, + "is_agree_marketing": { + "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", + "type": "boolean" + }, + "is_plugins_page_skipped": { + "description": "Whether or not plugins step in core profiler was skipped.", + "type": "boolean" + }, + "is_store_country_set": { + "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" + }, + "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" + }, + "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" + }, + "wccom_connected": { + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "industry": { + "description": "Industry.", + "type": "array" + }, + "is_agree_marketing": { + "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", + "type": "boolean" + }, + "is_plugins_page_skipped": { + "description": "Whether or not plugins step in core profiler was skipped.", + "type": "boolean" + }, + "is_store_country_set": { + "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" + }, + "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" + }, + "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" + }, + "wccom_connected": { + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "industry": { + "description": "Industry.", + "type": "array" + }, + "is_agree_marketing": { + "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", + "type": "boolean" + }, + "is_plugins_page_skipped": { + "description": "Whether or not plugins step in core profiler was skipped.", + "type": "boolean" + }, + "is_store_country_set": { + "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" + }, + "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" + }, + "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" + }, + "wccom_connected": { + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/profile/experimental_get_email_prefill": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks": { + "get": { + "parameters": [ + { + "description": "Optional parameter to get only specific task lists by ID.", + "in": "query", + "name": "ids", + "required": false, + "schema": { + "items": { + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extended_tasks": { + "description": "List of extended deprecated tasks from the client-side filter.", + "type": "array" + }, + "ids": { + "description": "Optional parameter to get only specific task lists by ID.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/create_homepage": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/create_product_from_template": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "template_name": { + "description": "Product template name.", + "required": true, + "type": "string" + } + }, + "required": [ + "template_name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/import_sample_products": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/action": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/dismiss": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/hide": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/snooze": { + "post": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/undo_dismiss": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/undo_snooze": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/unhide": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/themes/activate": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/themes/install": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/themes/recommended": { + "get": { + "parameters": [ + { + "description": "Limits the results to themes relevant for this industry (optional)", + "in": "query", + "name": "industry", + "required": false, + "schema": {} + }, + { + "description": "Returns pricing in this currency (optional, default: USD)", + "in": "query", + "name": "currency", + "required": false, + "schema": { + "enum": [ + "AUD", + "CAD", + "EUR", + "GBP", + "USD" + ] + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/options": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/payment-gateway-suggestions": { + "get": { + "parameters": [ + { + "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", + "in": "query", + "name": "force_default_suggestions", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/payment-gateway-suggestions/dismiss": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/activate": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/activate/status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/activate/status/{job_id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/active": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/connect-jetpack": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/connect-square": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/connect-wcpay": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/finish-wccom-connect": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/install": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/install/status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/install/status/{job_id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/installed": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/request-wccom-connect": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" } } } }, "/wc-admin/shipping-partner-suggestions": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping-partner-suggestions" } } - } - } - }, "parameters": [ { - "name": "force_default_suggestions", - "in": "query", "description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no", + "in": "query", + "name": "force_default_suggestions", "required": false, "schema": {} } - ] - } - }, - "/wc-admin/launch-your-store/initialize-coming-soon": { - "post": { "responses": { "200": { "description": "OK" } } } - }, - "/wc-admin/launch-your-store/update-survey-status": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "status": { "type": "string" } } } - } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping-partner-suggestions" + } + } + }, + "description": "OK" } } } }, - "/wc-admin/launch-your-store/survey-completed": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wc-admin/launch-your-store/woopayments/test-orders/count": { - "get": { "responses": { "200": { "description": "OK" } } } - }, - "/wc-admin/launch-your-store/woopayments/test-orders": { - "delete": { "responses": { "200": { "description": "OK" } } } + "/wc-admin/themes": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, + "description": "OK" + } + } + } }, "/wc-analytics": { "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc-analytics/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "users", - "in": "query", - "description": "Limit result to items with specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "filter_empty", - "in": "query", - "description": "Filter out results where any of the passed fields are empty", - "required": false, - "schema": { - "items": { "type": "string", "enum": ["email", "name", "country", "city", "state", "postcode"] } - } - }, - { - "name": "include", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wc-analytics/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "users", - "in": "query", - "description": "Limit result to items with specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "filter_empty", - "in": "query", - "description": "Filter out results where any of the passed fields are empty", - "required": false, - "schema": { - "items": { "type": "string", "enum": ["email", "name", "country", "city", "state", "postcode"] } - } - }, - { - "name": "include", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wc-analytics/leaderboards": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } } - } - }, - "parameters": [ - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 20 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "persisted_query", - "in": "query", - "description": "URL query to persist across links.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/leaderboards/allowed": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } } - } - } - } - }, - "/wc-analytics/leaderboards/{leaderboard}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } } - } - }, - "parameters": [ - { - "name": "leaderboard", - "in": "path", "description": "", - "required": true, - "schema": { "enum": ["customers", "coupons", "categories", "products"] } - }, - { - "name": "page", "in": "query", - "description": "Current page of the collection.", + "name": "namespace", "required": false, - "schema": { "minimum": 1 } + "schema": {} }, { - "name": "per_page", + "description": "", "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 20 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "persisted_query", - "in": "query", - "description": "URL query to persist across links.", + "name": "context", "required": false, "schema": {} } - ] - } - }, - "/wc-analytics/reports": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc-analytics/reports/import": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "days": { "type": "integer", "description": "Number of days to import." }, - "skip_existing": { "type": "boolean", "description": "Skip importing existing order data." } - } - } - } + "description": "OK" } } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "days": { "type": "integer", "description": "Number of days to import." }, - "skip_existing": { "type": "boolean", "description": "Skip importing existing order data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "days": { "type": "integer", "description": "Number of days to import." }, - "skip_existing": { "type": "boolean", "description": "Skip importing existing order data." } - } - } - } - } - } - } - }, - "/wc-analytics/reports/import/cancel": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - } - }, - "/wc-analytics/reports/import/delete": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - } - }, - "/wc-analytics/reports/import/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - } - }, - "/wc-analytics/reports/import/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "parameters": [ - { - "name": "days", - "in": "query", - "description": "Number of days to import.", - "required": false, - "schema": { "minimum": 0 } - }, - { - "name": "skip_existing", - "in": "query", - "description": "Skip importing existing order data.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/{type}/export": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } } - } - }, - "parameters": [{ "name": "type", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "report_args": { "type": "object", "description": "Parameters to pass on to the exported report." }, - "email": { - "type": "boolean", - "description": "When true, email a link to download the export to the requesting user." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } } - } - }, - "parameters": [{ "name": "type", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "report_args": { "type": "object", "description": "Parameters to pass on to the exported report." }, - "email": { - "type": "boolean", - "description": "When true, email a link to download the export to the requesting user." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } } - } - }, - "parameters": [{ "name": "type", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "report_args": { "type": "object", "description": "Parameters to pass on to the exported report." }, - "email": { - "type": "boolean", - "description": "When true, email a link to download the export to the requesting user." - } - } - } - } - } - } - } - }, - "/wc-analytics/reports/{type}/export/{export_id}/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export_status" } } } - } - }, - "parameters": [ - { "name": "type", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "export_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc-analytics/reports/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_products" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": ["date", "net_revenue", "orders_count", "items_sold", "product_name", "variations", "sku"] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "categories", - "in": "query", - "description": "Limit result to items from the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "products", - "in": "query", - "description": "Limit result to items with specified product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each product to the report.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_varitations" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "items_sold", "sku"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variations", - "in": "query", - "description": "Limit result to items with specified variation IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each variation to the report.", - "required": false, - "schema": {} - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to variations that include the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to variations that don't include the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "category_includes", - "in": "query", - "description": "Limit result set to variations in the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "category_excludes", - "in": "query", - "description": "Limit result set to variations not in the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "products", - "in": "query", - "description": "Limit result to items with specified product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wc-analytics/reports/products/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_products_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result to items from the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "products", - "in": "query", - "description": "Limit result to items with specified product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variations", - "in": "query", - "description": "Limit result to items with specified variation IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/variations/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_variations_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "category_includes", - "in": "query", - "description": "Limit result to items from the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "category_excludes", - "in": "query", - "description": "Limit result set to variations not in the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variations", - "in": "query", - "description": "Limit result to items with specified variation IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to orders that include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to orders that don't include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - } - ] - } - }, - "/wc-analytics/reports/revenue/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_revenue_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "total_sales", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold", - "gross_sales" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } - }, - { - "name": "date_type", - "in": "query", - "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", - "required": false, - "schema": { "enum": ["date_paid", "date_created", "date_completed"] } - } - ] - } - }, - "/wc-analytics/reports/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "num_items_sold", "net_total"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_includes", - "in": "query", - "description": "Limit result set to items that have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_includes", - "in": "query", - "description": "Limit result set to items that have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_includes", - "in": "query", - "description": "Limit result set to items that have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status_is", - "in": "query", - "description": "Limit result set to items that have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "status_is_not", - "in": "query", - "description": "Limit result set to items that don't have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "customer_type", - "in": "query", - "description": "Limit result set to returning or new customers.", - "required": false, - "schema": { "enum": ["", "returning", "new"] } - }, - { - "name": "refunds", - "in": "query", - "description": "Limit result set to specific types of refunds.", - "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each coupon to the report.", - "required": false, - "schema": {} - }, - { - "name": "order_includes", - "in": "query", - "description": "Limit result set to items that have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to orders that include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to orders that don't include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/orders/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "avg_order_value"] } - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "status_is", - "in": "query", - "description": "Limit result set to items that have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "status_is_not", - "in": "query", - "description": "Limit result set to items that don't have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_includes", - "in": "query", - "description": "Limit result set to items that have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_includes", - "in": "query", - "description": "Limit result set to items that have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_includes", - "in": "query", - "description": "Limit result set to items that have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer", - "in": "query", - "description": "Alias for customer_type (deprecated).", - "required": false, - "schema": { "enum": ["new", "returning"] } - }, - { - "name": "customer_type", - "in": "query", - "description": "Limit result set to orders that have the specified customer_type", - "required": false, - "schema": { "enum": ["new", "returning"] } - }, - { - "name": "refunds", - "in": "query", - "description": "Limit result set to specific types of refunds.", - "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to orders that include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to orders that don't include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_categories" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": ["category_id", "items_sold", "net_revenue", "orders_count", "products_count", "category"] - } - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "status_is", - "in": "query", - "description": "Limit result set to items that have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "status_is_not", - "in": "query", - "description": "Limit result set to items that don't have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each category to the report.", - "required": false, - "schema": {} - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "name", - "tax_rate_id", - "tax_code", - "rate", - "order_tax", - "total_tax", - "shipping_tax", - "orders_count" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "taxes", - "in": "query", - "description": "Limit result set to items assigned one or more tax rates.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/taxes/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "items_sold", "total_sales", "orders_count", "products_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "taxes", - "in": "query", - "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["tax_rate_id"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["coupon_id", "code", "amount", "orders_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "coupons", - "in": "query", - "description": "Limit result set to coupons assigned specific coupon IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each coupon to the report.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/coupons/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "amount", "coupons_count", "orders_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "coupons", - "in": "query", - "description": "Limit result set to coupons assigned specific coupon IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "variation", "category", "coupon"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/stock": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_stock" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["stock_status", "stock_quantity", "date", "id", "include", "title", "sku"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to items assigned a stock report type.", - "required": false, - "schema": { "enum": ["all", "lowstock", "instock", "outofstock", "onbackorder"] } - } - ] - } - }, - "/wc-analytics/reports/stock/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc-analytics/reports/downloads": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_downloads" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "product"] } - }, - { - "name": "match", - "in": "query", - "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.", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_includes", - "in": "query", - "description": "Limit result set to items that have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_includes", - "in": "query", - "description": "Limit response to objects that have the specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_excludes", - "in": "query", - "description": "Limit response to objects that don't have the specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "ip_address_includes", - "in": "query", - "description": "Limit response to objects that have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "ip_address_excludes", - "in": "query", - "description": "Limit response to objects that don't have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/downloads/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "download_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_includes", - "in": "query", - "description": "Limit result set to items that have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_includes", - "in": "query", - "description": "Limit response to objects that have the specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_excludes", - "in": "query", - "description": "Limit response to objects that don't have the specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "ip_address_includes", - "in": "query", - "description": "Limit response to objects that have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "ip_address_excludes", - "in": "query", - "description": "Limit response to objects that don't have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "customers", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "users", - "in": "query", - "description": "Limit result to items with specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "filter_empty", - "in": "query", - "description": "Filter out results where any of the passed fields are empty", - "required": false, - "schema": { - "items": { "type": "string", "enum": ["email", "name", "country", "city", "state", "postcode"] } - } - } - ] - } - }, - "/wc-analytics/reports/customers/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "customers", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/performance-indicators": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "stats", - "in": "query", - "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.", - "required": false, - "schema": { - "items": { - "type": "string", - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - } - } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - } - ] - } - }, - "/wc-analytics/reports/performance-indicators/allowed": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "stats", - "in": "query", - "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.", - "required": false, - "schema": { - "items": { - "type": "string", - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - } - } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - } - ] } }, "/wc-analytics/admin/notes": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "type", - "in": "query", "description": "Type of note.", + "in": "query", + "name": "type", "required": false, "schema": { "items": { - "enum": ["error", "warning", "update", "info", "marketing", "survey", "email"], + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], "type": "string" } } }, { - "name": "status", - "in": "query", "description": "Status of note.", + "in": "query", + "name": "status", "required": false, "schema": { - "items": { "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], "type": "string" } + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + } } }, { - "name": "source", - "in": "query", "description": "Source of note.", + "in": "query", + "name": "source", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } - ] - } - }, - "/wc-analytics/admin/notes/{id}": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - } - }, - "/wc-analytics/admin/notes/delete/{id}": { - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] + } } }, "/wc-analytics/admin/notes/delete/all": { "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "status": { "type": "array", "description": "Status of note." } } + "properties": { + "status": { + "description": "Status of note.", + "type": "array" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/admin/notes/delete/{id}": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/admin/notes/experimental-activate-promo/{promo_note_name}": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } } } }, "/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": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "note_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} } - ] + } } }, "/wc-analytics/admin/notes/update": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + }, "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } } }, "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } } } }, - "/wc-analytics/admin/notes/experimental-activate-promo/{promo_note_name}": { - "post": { + "/wc-analytics/admin/notes/{id}": { + "get": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "promo_note_name", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [{ "name": "promo_note_name", "in": "path", "description": "", "required": true, "schema": {} }] + } }, "patch": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "promo_note_name", "in": "path", "description": "", "required": true, "schema": {} }] + } + }, + "post": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } } }, "/wc-analytics/admin/notes/{note_id}/action/{action_id}": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, + "patch": { "parameters": [ - { "name": "note_id", "in": "path", "description": "Unique ID for the Note.", "required": true, "schema": {} }, { - "name": "action_id", + "description": "Unique ID for the Note.", "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, + { "description": "Unique ID for the Note Action.", + "in": "path", + "name": "action_id", "required": true, "schema": {} } - ] + ], + "responses": { + "200": { + "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 Action.", + "in": "path", + "name": "action_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, "parameters": [ - { "name": "note_id", "in": "path", "description": "Unique ID for the Note.", "required": true, "schema": {} }, { - "name": "action_id", + "description": "Unique ID for the Note.", "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, + { "description": "Unique ID for the Note Action.", + "in": "path", + "name": "action_id", "required": true, "schema": {} } - ] - }, - "patch": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "note_id", "in": "path", "description": "Unique ID for the Note.", "required": true, "schema": {} }, - { - "name": "action_id", - "in": "path", - "description": "Unique ID for the Note Action.", - "required": true, - "schema": {} - } - ] + } } }, "/wc-analytics/coupons": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to coupons with codes matching a given string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "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" + ] + } }, { - "name": "code", - "in": "query", "description": "Limit result set to resources with a specific code.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["code"] - } - } - } - } - } - }, - "/wc-analytics/coupons/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "code", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "description": { + "description": "Coupon description.", + "type": "string" }, "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" }, "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" }, "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." + "description": "How many times the coupon can be used in total.", + "type": "integer" }, "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" } } } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" } } - } + }, + "description": "OK" } } } }, "/wc-analytics/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." + "description": { + "description": "Coupon description.", + "type": "string" }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." + "description": { + "description": "Coupon description.", + "type": "string" }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/coupons/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." + "description": { + "description": "Coupon description.", + "type": "string" }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/customers": { + "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": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "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" + } + }, + { + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified user IDs.", + "in": "query", + "name": "users", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Filter out results where any of the passed fields are empty", + "in": "query", + "name": "filter_empty", + "required": false, + "schema": { + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/customers/{id}": { + "get": { + "parameters": [ + { + "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": [ + "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": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "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" + } + }, + { + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified user IDs.", + "in": "query", + "name": "users", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Filter out results where any of the passed fields are empty", + "in": "query", + "name": "filter_empty", + "required": false, + "schema": { + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, + "description": "OK" + } } } }, @@ -31671,18 +30886,14 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-analytics/data/countries/locales": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } @@ -31691,4898 +30902,4238 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/data/countries/locales": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" } } } }, "/wc-analytics/data/countries/{location}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } - } - }, "parameters": [ { - "name": "location", - "in": "path", "description": "ISO3166 alpha-2 country code.", + "in": "path", + "name": "location", "required": true, "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } } }, "/wc-analytics/data/download-ips": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_download_ips" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_download_ips" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/leaderboards": { + "get": { + "parameters": [ + { + "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": 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" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "URL query to persist across links.", + "in": "query", + "name": "persisted_query", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/leaderboards/allowed": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/leaderboards/{leaderboard}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "leaderboard", + "required": true, + "schema": { + "enum": [ + "categories", + "coupons", + "customers", + "products" + ] + } + }, + { + "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": 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" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "URL query to persist across links.", + "in": "query", + "name": "persisted_query", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, + "description": "OK" } } } }, "/wc-analytics/orders": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders which have specific statuses.", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to orders which have specific statuses.", + "in": "query", + "name": "status", "required": false, "schema": { "items": { - "type": "string", "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" - ] + "trash" + ], + "type": "string" } } }, { - "name": "customer", - "in": "query", "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", "required": false, "schema": {} }, { - "name": "product", - "in": "query", "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", "required": false, "schema": {} }, { - "name": "dp", - "in": "query", "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", "required": false, "schema": {} }, { - "name": "order_item_display_meta", - "in": "query", "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", "required": false, "schema": {} }, { - "name": "include_meta", - "in": "query", "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "exclude_meta", - "in": "query", "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "number", - "in": "query", "description": "Limit result set to orders matching part of an order number.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - } - }, - "/wc-analytics/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "number", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "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" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "type": "boolean" }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" } } } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "delete": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" } } - } + }, + "description": "OK" } } } }, "/wc-analytics/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Search by similar product name or SKU.", - "required": false, - "schema": {} - }, - { - "name": "after", "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order", - "price", - "popularity", - "rating" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "search_sku", - "in": "query", - "description": "Limit results to those with a SKU that partially matches a string.", - "required": false, - "schema": {} - }, - { - "name": "low_in_stock", - "in": "query", - "description": "Limit result set to products that are low or out of stock. (Deprecated)", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc-analytics/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc-analytics/products/suggested-products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", "required": false, "schema": { "enum": [ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", + "popularity", + "price", "rating", - "menu_order" + "rating", + "rating", + "slug", + "title" ] } }, { - "name": "parent", - "in": "query", "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "parent_exclude", - "in": "query", "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" + } + } }, { - "name": "slug", - "in": "query", "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", "required": false, "schema": {} }, { - "name": "status", - "in": "query", "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { - "name": "type", - "in": "query", "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" + ] + } }, { - "name": "sku", - "in": "query", "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", "required": false, "schema": {} }, { - "name": "featured", - "in": "query", "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", "required": false, "schema": {} }, { - "name": "category", - "in": "query", "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", "required": false, "schema": {} }, { - "name": "tag", - "in": "query", "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", "required": false, "schema": {} }, { - "name": "shipping_class", - "in": "query", "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", "required": false, "schema": {} }, { - "name": "attribute", - "in": "query", "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", "required": false, "schema": {} }, { - "name": "attribute_term", - "in": "query", "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", "required": false, "schema": {} }, { - "name": "in_stock", - "in": "query", - "description": "Limit result set to products in stock or out of stock.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", "required": false, "schema": {} }, { - "name": "min_price", - "in": "query", "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", "required": false, "schema": {} }, { - "name": "max_price", - "in": "query", "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", "required": false, "schema": {} }, { - "name": "include_meta", - "in": "query", "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "exclude_meta", - "in": "query", "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "categories", + "description": "Limit result set to products with specified stock status.", "in": "query", - "description": "Limit result set to specific product categorie ids.", + "name": "stock_status", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { - "name": "tags", + "description": "Limit results to those with a SKU that partially matches a string.", "in": "query", - "description": "Limit result set to specific product tag ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "limit", - "in": "query", - "description": "Limit result set to specific amount of suggested products.", + "name": "search_sku", "required": false, "schema": {} - } - ] - } - }, - "/wc-analytics/products/{id}/duplicate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ + }, { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, + "description": "Limit result set to products that are low or out of stock. (Deprecated)", + "in": "query", + "name": "low_in_stock", + "required": false, "schema": {} } ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." + "attributes": { + "description": "List of attributes.", + "type": "array" }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "description": "Product external button text. Only for external products.", + "type": "string" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "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" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" }, "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." + "description": "Low Stock amount for the product.", + "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" + }, + "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" }, "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "description": "Allow one item to be bought in a single order.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "status": { + "description": "Product status (post status).", + "type": "string" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/attributes": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "search", - "in": "query", "description": "Search by similar attribute name.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc-analytics/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "search", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "order_by": { + "description": "Default sort order.", + "type": "string" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" } - } + }, + "required": [ + "name" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } + "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": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } + "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": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "description": { + "description": "HTML description of the resource.", + "type": "string" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/attributes/{slug}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, "parameters": [ { - "name": "slug", - "in": "path", "description": "Slug identifier for the resource.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc-analytics/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, + "required": true, "schema": {} } - ] - }, - "post": { + ], "responses": { "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc-analytics/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc-analytics/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } + }, + "description": "OK" } } } }, "/wc-analytics/products/attributes/{slug}/terms": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, "parameters": [ { - "name": "slug", - "in": "path", "description": "Limit result set to resources with a specific slug.", + "in": "path", + "name": "slug", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", "in": "query", - "description": "Limit result set to specific ids.", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] + "schema": { + "items": { + "type": "integer" } } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" } } } }, - "/wc-analytics/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], + "/wc-analytics/products/batch": { + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "attributes": { + "description": "List of attributes.", + "type": "array" }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "attributes": { + "description": "List of attributes.", + "type": "array" }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Category name." }, + "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": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "has_price", - "in": "query", - "description": "Limit result set to products with or without price.", - "required": false, - "schema": {} - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with specified attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { "type": "string", "description": "Attribute slug." }, - "term": { "type": "string", "description": "Attribute term." }, - "terms": { "type": "array", "description": "Attribute terms." } - } - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations/generate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "delete": { "type": "boolean", "description": "Deletes unused variations." }, - "default_values": { "type": "object", "description": "Default values for generated variations." }, - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - } - }, - "/wc-analytics/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "has_price", - "in": "query", - "description": "Limit result set to products with or without price.", - "required": false, - "schema": {} - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with specified attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { "type": "string", "description": "Attribute slug." }, - "term": { "type": "string", "description": "Attribute term." }, - "terms": { "type": "array", "description": "Attribute terms." } - } - } - } - } - ] - } - }, - "/wc-analytics/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to reviews published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } - }, - { - "name": "reviewer", - "in": "query", - "description": "Limit result set to reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_exclude", - "in": "query", - "description": "Ensure result set excludes reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_email", - "in": "query", - "description": "Limit result set to that from a specific author email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to reviews assigned to specific product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to reviews assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "required": true, - "description": "Unique identifier for the product." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "reviewer_email": { "type": "string", "required": true, "description": "Email of the reviewer." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"] + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } } }, - "/wc-analytics/products/reviews/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, + "/wc-analytics/products/categories/{id}": { + "delete": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } + "schema": { + "enum": [ + "edit", + "view" + ] } } - } - }, - "put": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" } } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -36591,36 +35142,60 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." + "description": { + "description": "HTML description of the resource.", + "type": "string" }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, + "post": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -36629,2795 +35204,9152 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } } }, - "/wc-analytics/products/reviews/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } + "/wc-analytics/products/count-low-in-stock": { + "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": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] } } - } - }, - "put": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Count Low in Stock Items" } } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } + }, + "description": "OK" } } } }, "/wc-analytics/products/low-in-stock": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "status", - "in": "query", "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } - } - ] - } - }, - "/wc-analytics/products/count-low-in-stock": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Count Low in Stock Items" } } + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] } } - }, + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/reviews": { + "get": { "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "status", + "description": "Current page of the collection.", "in": "query", - "description": "Limit result set to products assigned a specific status.", + "name": "page", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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 reviews published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "description": "Ensure result set excludes reviews assigned to specific user IDs.", + "in": "query", + "name": "reviewer_exclude", + "required": false, + "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" + } + }, + { + "description": "Limit result set to reviews assigned to specific product IDs.", + "in": "query", + "name": "product", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to reviews assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } } - ] - } - }, - "/wc-analytics/settings/{group_id}": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc-analytics/settings/{group_id}/batch": { + } + }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "product_id": { + "description": "Unique identifier for the product.", + "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" } - } + }, + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/reviews/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/suggested-products": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to specific product categorie ids.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific product tag ids.", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific amount of suggested products.", + "in": "query", + "name": "limit", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{id}/duplicate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_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": [ + "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": "Search by similar product name, SKU, or attribute value.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit result set to products with or without price.", + "in": "query", + "name": "has_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations/generate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/categories": { + "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": [ + "category", + "category_id", + "items_sold", + "net_revenue", + "orders_count", + "products_count" + ] + } + }, + { + "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": "Limit result set to items that have the specified order status.", + "in": "query", + "name": "status_is", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that don't have the specified order status.", + "in": "query", + "name": "status_is_not", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each category to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_categories" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/coupons": { + "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": [ + "amount", + "code", + "coupon_id", + "orders_count" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to coupons assigned specific coupon IDs.", + "in": "query", + "name": "coupons", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each coupon to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupons" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/coupons/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": [ + "amount", + "coupons_count", + "date", + "orders_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": [ + "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" + } + } + }, + { + "description": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "schema": { + "enum": [ + "category", + "coupon", + "product", + "variation" + ] + } + }, + { + "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_coupons_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/customers": { + "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": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "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" + } + }, + { + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "customers", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified user IDs.", + "in": "query", + "name": "users", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Filter out results where any of the passed fields are empty", + "in": "query", + "name": "filter_empty", + "required": false, + "schema": { + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/customers/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": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_before", + "required": false, + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "customers", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit stats fields to the specified items.", + "in": "query", + "name": "fields", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/downloads": { + "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": [ + "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" + ] + } + }, + { + "description": "Limit result set to items that have the specified product(s) assigned.", + "in": "query", + "name": "product_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified order IDs.", + "in": "query", + "name": "order_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have the specified user IDs.", + "in": "query", + "name": "customer_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have a specified IP address.", + "in": "query", + "name": "ip_address_includes", + "required": false, + "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" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_downloads" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/downloads/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": [ + "date", + "download_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": [ + "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 set to items that have the specified product(s) assigned.", + "in": "query", + "name": "product_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified order IDs.", + "in": "query", + "name": "order_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have the specified customer IDs.", + "in": "query", + "name": "customer_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have a specified IP address.", + "in": "query", + "name": "ip_address_includes", + "required": false, + "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" + } + } + }, + { + "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_orders_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import/cancel": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } } }, "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" } } - } + }, + "description": "OK" } } - }, + } + }, + "/wc-analytics/reports/import/delete": { "patch": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import/status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import/totals": { + "get": { + "parameters": [ + { + "description": "Number of days to import.", + "in": "query", + "name": "days", + "required": false, + "schema": { + "minimum": 0 + } + }, + { + "description": "Skip importing existing order data.", + "in": "query", + "name": "skip_existing", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/orders": { + "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": 0 + } + }, + { + "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": [ + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified variation(s) assigned.", + "in": "query", + "name": "variation_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified coupon(s) assigned.", + "in": "query", + "name": "coupon_includes", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified order status.", + "in": "query", + "name": "status_is", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that don't have the specified order status.", + "in": "query", + "name": "status_is_not", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to returning or new customers.", + "in": "query", + "name": "customer_type", + "required": false, + "schema": { + "enum": [ + "", + "new", + "returning" + ] + } + }, + { + "description": "Limit result set to specific types of refunds.", + "in": "query", + "name": "refunds", + "required": false, + "schema": { + "enum": [ + "", + "all", + "full", + "none", + "partial" + ] + } + }, + { + "description": "Add additional piece of info about each coupon to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to items that have the specified order IDs.", + "in": "query", + "name": "order_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to orders that include products with the specified attributes.", + "in": "query", + "name": "attribute_is", + "required": false, + "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" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/orders/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": [ + "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": [ + "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 set to items that have the specified order status.", + "in": "query", + "name": "status_is", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that don't have the specified order status.", + "in": "query", + "name": "status_is_not", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that have the specified product(s) assigned.", + "in": "query", + "name": "product_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified variation(s) assigned.", + "in": "query", + "name": "variation_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified coupon(s) assigned.", + "in": "query", + "name": "coupon_includes", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Alias for customer_type (deprecated).", + "in": "query", + "name": "customer", + "required": false, + "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" + ] + } + }, + { + "description": "Limit result set to specific types of refunds.", + "in": "query", + "name": "refunds", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "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" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/performance-indicators": { + "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": "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.", + "in": "query", + "name": "stats", + "required": false, + "schema": { + "items": { + "enum": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "type": "string" + } + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/performance-indicators/allowed": { + "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": "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.", + "in": "query", + "name": "stats", + "required": false, + "schema": { + "items": { + "enum": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "type": "string" + } + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/products": { + "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": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "product_name", + "sku", + "variations" + ] + } + }, + { + "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 from the specified categories.", + "in": "query", + "name": "categories", + "required": false, + "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" + ] + } + }, + { + "description": "Limit result to items with specified product IDs.", + "in": "query", + "name": "products", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each product to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/products/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": "Limit result to items from the specified categories.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified product IDs.", + "in": "query", + "name": "products", + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/revenue/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", + "gross_sales", + "items_sold", + "net_revenue", + "orders_count", + "refunds", + "shipping", + "taxes", + "total_sales" + ] + } + }, + { + "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": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "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_completed", + "date_created", + "date_paid" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_revenue_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/stock": { + "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": "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", + "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" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items assigned a stock report type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "all", + "instock", + "lowstock", + "onbackorder", + "outofstock" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_stock" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/stock/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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/taxes": { + "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": [ + "name", + "order_tax", + "orders_count", + "rate", + "shipping_tax", + "tax_code", + "tax_rate_id", + "total_tax" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to items assigned one or more tax rates.", + "in": "query", + "name": "taxes", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_taxes" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/taxes/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": [ + "date", + "items_sold", + "orders_count", + "products_count", + "total_sales" + ] + } + }, + { + "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": "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": [ + "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" + } + } + }, + { + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_variations_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/{type}/export": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "email": { + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "email": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "email": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export_status" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/settings/{group_id}/batch": { + "patch": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/settings/{group_id}/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, { - "name": "id", - "in": "path", + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "group_id", "required": true, "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/taxes": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { - "name": "class", - "in": "query", "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" + ] + } }, { - "name": "search", - "in": "query", "description": "Search by similar tax code.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "include", - "in": "query", "description": "Limit result set to items that have the specified rate ID(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc-analytics/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "include", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "items": { + "type": "integer" + } + } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "type": "string" }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." + "class": { + "description": "Tax class.", + "type": "string" }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." + "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" }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "priority": { + "description": "Tax priority.", + "type": "integer" }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." + "rate": { + "description": "Tax rate.", + "type": "string" }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "state": { + "description": "State code.", + "type": "string" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "type": "string" }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." + "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" }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc/store": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/store/batch": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "validation": { "type": "string" }, "requests": { "type": "array", "required": true } }, - "required": ["requests"] - } - } - } - } - } - }, - "/wc/store/cart": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/cart/add-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "The basket item product or variation ID." }, - "quantity": { "type": "integer", "description": "Quantity of this item to add to the basket." }, - "variation": { "type": "array", "description": "Chosen attributes (for variations)." } - } - } - } - } - } - } - }, - "/wc/store/cart/apply-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/cart/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "The coupon's unique code." }, - "discount_type": { - "type": "string", - "description": "The discount type for the coupon (eg percentage or fixed amount)" - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - } - } - }, - "/wc/store/cart/coupons/{code}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/cart/extensions": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "namespace": { - "type": "string", - "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately." + "priority": { + "description": "Tax priority.", + "type": "integer" }, - "data": { "type": "object", "description": "Additional data to pass to the extension" } - } - } - } - } - } - } - }, - "/wc/store/cart/items": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - } - } - }, - "/wc/store/cart/items/{key}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/cart/remove-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/cart/remove-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item." } - } - } - } - } - } - } - }, - "/wc/store/cart/select-shipping-rate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "package_id": { - "type": ["integer", "string", "null"], - "required": false, - "description": "The ID of the package being shipped. Leave blank to apply to all packages." + "rate": { + "description": "Tax rate.", + "type": "string" }, - "rate_id": { - "type": "string", - "required": true, - "description": "The chosen rate ID for the package." + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" } }, - "required": ["rate_id"] + "type": "object" } } } - } - } - }, - "/wc/store/cart/update-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item to update." }, - "quantity": { "type": "integer", "description": "New quantity of the item in the basket." } - } - } - } - } - } - } - }, - "/wc/store/cart/update-customer": { - "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "billing_address": { "type": "object", "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." } - } - } - } - } - } - } - }, - "/wc/store/checkout": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_password": { - "type": "string", - "description": "Customer password for new accounts, if applicable." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "create_account": { - "type": "boolean", - "description": "Whether to create a new user account as part of order processing." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/checkout/{id}": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/order/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/store/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wc/store/products/collection-data": { - "get": { - "responses": { - "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "type": "string" }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" + "class": { + "description": "Tax class.", + "type": "string" }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] + "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" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" } } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - }, - { - "name": "calculate_price_range", - "in": "query", - "description": "If true, calculates the minimum and maximum product prices for the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_stock_status_counts", - "in": "query", - "description": "If true, calculates stock counts for products in the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_attribute_counts", - "in": "query", - "description": "If requested, calculates attribute term counts for products in the collection.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "taxonomy": { - "description": "Taxonomy name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "query_type": { - "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "type": "string", - "enum": ["and", "or"], - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - { - "name": "calculate_rating_counts", - "in": "query", - "description": "If true, calculates rating counts for products in the collection.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } - }, - { - "name": "category_id", - "in": "query", - "description": "Limit result set to reviews from specific category IDs.", - "required": false, - "schema": {} - }, - { - "name": "product_id", - "in": "query", - "description": "Limit result set to reviews from specific product IDs.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] - } - } - } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - } - ] - } - }, - "/wc/store/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/products/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { "name": "slug", "in": "path", "description": "Slug of the resource.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/store/v1/batch": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "validation": { "type": "string" }, "requests": { "type": "array", "required": true } }, - "required": ["requests"] - } - } - } - } - } - }, - "/wc/store/v1/cart": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1/cart/add-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "The basket item product or variation ID." }, - "quantity": { "type": "integer", "description": "Quantity of this item to add to the basket." }, - "variation": { "type": "array", "description": "Chosen attributes (for variations)." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/apply-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "The coupon's unique code." }, - "discount_type": { - "type": "string", - "description": "The discount type for the coupon (eg percentage or fixed amount)" - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - } - } - }, - "/wc/store/v1/cart/coupons/{code}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/v1/cart/extensions": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "namespace": { - "type": "string", - "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately." - }, - "data": { "type": "object", "description": "Additional data to pass to the extension" } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/items": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - } - } - }, - "/wc/store/v1/cart/items/{key}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } + }, + "description": "OK" } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } } }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/taxes/{id}": { + "delete": { "parameters": [ { - "name": "key", + "description": "Unique identifier for the resource.", "in": "path", - "description": "Unique identifier for the item within the basket.", + "name": "id", "required": true, "schema": {} } @@ -39425,1491 +44357,904 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, "parameters": [ { - "name": "key", + "description": "Unique identifier for the resource.", "in": "path", - "description": "Unique identifier for the item within the basket.", + "name": "id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/v1/cart/remove-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/remove-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/select-shipping-rate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "package_id": { - "type": ["integer", "string", "null"], - "required": false, - "description": "The ID of the package being shipped. Leave blank to apply to all packages." + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, - "rate_id": { - "type": "string", - "required": true, - "description": "The chosen rate ID for the package." + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" } }, - "required": ["rate_id"] + "type": "object" } } } - } - } - }, - "/wc/store/v1/cart/update-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item to update." }, - "quantity": { "type": "integer", "description": "New quantity of the item in the basket." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/update-customer": { - "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "billing_address": { "type": "object", "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." } - } - } - } - } - } - } - }, - "/wc/store/v1/checkout": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_password": { - "type": "string", - "description": "Customer password for new accounts, if applicable." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "create_account": { - "type": "boolean", - "description": "Whether to create a new user account as part of order processing." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/v1/checkout/{id}": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/v1/order/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/store/v1/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wc/store/v1/products/collection-data": { - "get": { - "responses": { - "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" } } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - }, - { - "name": "calculate_price_range", - "in": "query", - "description": "If true, calculates the minimum and maximum product prices for the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_stock_status_counts", - "in": "query", - "description": "If true, calculates stock counts for products in the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_attribute_counts", - "in": "query", - "description": "If requested, calculates attribute term counts for products in the collection.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "taxonomy": { - "description": "Taxonomy name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "query_type": { - "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "type": "string", - "enum": ["and", "or"], - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - { - "name": "calculate_rating_counts", - "in": "query", - "description": "If true, calculates rating counts for products in the collection.", - "required": false, - "schema": {} + }, + "description": "OK" } - ] - } - }, - "/wc/store/v1/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, + } + }, + "post": { "parameters": [ { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } - }, - { - "name": "category_id", - "in": "query", - "description": "Limit result set to reviews from specific category IDs.", - "required": false, - "schema": {} - }, - { - "name": "product_id", - "in": "query", - "description": "Limit result set to reviews from specific product IDs.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] - } - } - } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - } - ] - } - }, - "/wc/store/v1/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } } - ] - } - }, - "/wc/store/v1/products/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } } }, - "parameters": [ - { "name": "slug", "in": "path", "description": "Slug of the resource.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" } - ] + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/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": "Search by similar product name, SKU, or attribute value.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit result set to products with or without price.", + "in": "query", + "name": "has_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-telemetry": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-telemetry/tracker": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "installation_date": { + "description": "Installation date of the WooCommerce mobile app.", + "required": false, + "type": "string" + }, + "platform": { + "description": "Platform to track.", + "required": true, + "type": "string" + }, + "version": { + "description": "Platform version to track.", + "required": true, + "type": "string" + } + }, + "required": [ + "platform", + "version" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/private": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/private/ai/store-title": { - "post": { + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-title" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - } - } - } - } - } - } - } - }, - "/wc/private/ai/images": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/images" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - } - } - } - } - } - } - } - }, - "/wc/private/ai/patterns": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - }, - "images": { "type": "object", "description": "The images for a given store." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } } - } - } - } - }, - "/wc/private/ai/product": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "products_information": { - "type": "object", - "description": "Data generated by AI for updating dummy products." - }, - "last_product": { - "type": "boolean", - "description": "Whether the product being updated is the last one in the loop" - } - } - } - } - } - } - } - }, - "/wc/private/ai/products": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - }, - "images": { "type": "object", "description": "The images for a given store." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } } + "description": "OK" } } } }, "/wc/private/ai/business-description": { "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/ai/business-description" } } - } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { "business_description": { - "type": "string", - "description": "The business description for a given store." + "description": "The business description for a given store.", + "type": "string" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/business-description" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/images": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/images" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/patterns": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + }, + "images": { + "description": "The images for a given store.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/product": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "last_product": { + "description": "Whether the product being updated is the last one in the loop", + "type": "boolean" + }, + "products_information": { + "description": "Data generated by AI for updating dummy products.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/products": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + }, + "images": { + "description": "The images for a given store.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, + "description": "OK" + } } } }, @@ -40917,8 +45262,45 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-info" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-info" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/store-title": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-title" + } + } + }, + "description": "OK" } } } @@ -40927,10982 +45309,5349 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, + "description": "OK" } } }, "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/batch": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/cart": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/add-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/apply-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/coupons": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/coupons/{code}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/extensions": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/items": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/items/{key}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/remove-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/remove-item": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/select-shipping-rate": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "package_id": { + "description": "The ID of the package being shipped. Leave blank to apply to all packages.", + "required": false, + "type": [ + "integer", + "null", + "string" + ] + }, + "rate_id": { + "description": "The chosen rate ID for the package.", + "required": true, + "type": "string" + } + }, + "required": [ + "rate_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/update-customer": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/update-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/checkout": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "customer_password": { + "description": "Customer password for new accounts, if applicable.", + "type": "string" + }, + "extensions": { + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/checkout/{id}": { + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/order/{id}": { + "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": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute.", + "in": "path", + "name": "attribute_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": [ + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/attributes/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/categories": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/categories/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/collection-data": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + }, + { + "description": "If true, calculates the minimum and maximum product prices for the collection.", + "in": "query", + "name": "calculate_price_range", + "required": false, + "schema": {} + }, + { + "description": "If true, calculates stock counts for products in the collection.", + "in": "query", + "name": "calculate_stock_status_counts", + "required": false, + "schema": {} + }, + { + "description": "If requested, calculates attribute term counts for products in the collection.", + "in": "query", + "name": "calculate_attribute_counts", + "required": false, + "schema": { + "items": { + "properties": { + "query_type": { + "context": [ + "edit", + "view" + ], + "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", + "enum": [ + "and", + "or" + ], + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomy name.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + } + }, + { + "description": "If true, calculates rating counts for products in the collection.", + "in": "query", + "name": "calculate_rating_counts", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/reviews": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "date_gmt", + "id", + "product", + "rating" + ] + } + }, + { + "description": "Limit result set to reviews from specific category IDs.", + "in": "query", + "name": "category_id", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to reviews from specific product IDs.", + "in": "query", + "name": "product_id", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/tags": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/{slug}": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/v1/batch": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/add-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/apply-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/coupons": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/coupons/{code}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/extensions": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/items": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/items/{key}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/remove-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/remove-item": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/select-shipping-rate": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "package_id": { + "description": "The ID of the package being shipped. Leave blank to apply to all packages.", + "required": false, + "type": [ + "integer", + "null", + "string" + ] + }, + "rate_id": { + "description": "The chosen rate ID for the package.", + "required": true, + "type": "string" + } + }, + "required": [ + "rate_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/update-customer": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/update-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/checkout": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "customer_password": { + "description": "Customer password for new accounts, if applicable.", + "type": "string" + }, + "extensions": { + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/checkout/{id}": { + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/order/{id}": { + "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": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute.", + "in": "path", + "name": "attribute_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": [ + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/attributes/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/categories": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/categories/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/collection-data": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + }, + { + "description": "If true, calculates the minimum and maximum product prices for the collection.", + "in": "query", + "name": "calculate_price_range", + "required": false, + "schema": {} + }, + { + "description": "If true, calculates stock counts for products in the collection.", + "in": "query", + "name": "calculate_stock_status_counts", + "required": false, + "schema": {} + }, + { + "description": "If requested, calculates attribute term counts for products in the collection.", + "in": "query", + "name": "calculate_attribute_counts", + "required": false, + "schema": { + "items": { + "properties": { + "query_type": { + "context": [ + "edit", + "view" + ], + "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", + "enum": [ + "and", + "or" + ], + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomy name.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + } + }, + { + "description": "If true, calculates rating counts for products in the collection.", + "in": "query", + "name": "calculate_rating_counts", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/reviews": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "date_gmt", + "id", + "product", + "rating" + ] + } + }, + { + "description": "Limit result set to reviews from specific category IDs.", + "in": "query", + "name": "category_id", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to reviews from specific product IDs.", + "in": "query", + "name": "product_id", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/tags": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/{slug}": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" } } } }, "/wc/v1": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v1/coupons": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", - "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "code", - "in": "query", - "description": "Limit result set to resources with a specific code.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - }, - "required": ["code"] - } - } - } - } - } - }, - "/wc/v1/coupons/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - } - }, - "/wc/v1/customers/{customer_id}/downloads": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } } - } - }, - "parameters": [ - { - "name": "customer_id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v1/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } - }, - { - "name": "email", - "in": "query", - "description": "Limit result set to resources with a specific email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "role", - "in": "query", - "description": "Limit result set to resources with a specific role.", "required": false, "schema": { "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "required": true, "description": "New user email address." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "required": false, "description": "New user username." }, - "password": { "type": "string", "required": true, "description": "New user password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - }, - "required": ["email", "password"] - } - } - } - } - } - }, - "/wc/v1/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - }, - "reassign": { "type": "integer", "description": "ID to reassign posts to." } - } - } - } - } - } - } - }, - "/wc/v1/customers/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/notes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "note": { "type": "string", "required": true, "description": "Order note content." }, - "customer_note": { - "type": "boolean", - "description": "Shows/define if the note is only for reference or for the customer (the user will be notified)." - } - }, - "required": ["note"] - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/notes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", - "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders assigned a specific status.", - "required": false, - "schema": { - "enum": [ - "any", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "edit", + "view" ] } }, { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "amount": { "type": "string", "description": "Refund amount." }, - "reason": { "type": "string", "description": "Reason for refund." } - } - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/refunds/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", - "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders assigned a specific status.", + "name": "order", "required": false, "schema": { "enum": [ - "any", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "asc", + "desc" ] } }, { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - } - }, - "/wc/v1/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - } - }, - "/wc/v1/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products/{product_id}/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "query", - "description": "Unique identifier for the variation.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "Unique identifier for the variation." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "email": { "type": "string", "required": true, "description": "Email of the reviewer." } - }, - "required": ["review", "name", "email"] - } - } - } - } - } - }, - "/wc/v1/products/{product_id}/reviews/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/products/shipping_classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/shipping_classes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/shipping_classes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/tags/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with a specific SKU.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - } - }, - "/wc/v1/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - } - }, - "/wc/v1/reports/sales": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v1/reports/top_sellers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v1/reports": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v1/taxes/classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "name": { "type": "string", "required": true, "description": "Tax class name." } }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/taxes/classes/{slug}": { - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "order", "priority"] } - }, - { - "name": "class", - "in": "query", - "description": "Sort by tax class.", - "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v1/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v1/webhooks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "title"] } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to webhooks assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "required": true, "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - }, - "delivery_url": { "type": "string", "required": true, "description": "Webhook delivery URL." } - }, - "required": ["topic", "delivery_url"] - } - } - } - } - } - }, - "/wc/v1/webhooks/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/webhooks/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - } - }, - "/wc/v1/webhooks/{webhook_id}/deliveries": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v1/webhooks/{webhook_id}/deliveries/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/v2/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "code", - "in": "query", - "description": "Limit result set to resources with a specific code.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["code"] - } - } - } - } - } - }, - "/wc/v2/coupons/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v2/customers/{customer_id}/downloads": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } } - } - }, - "parameters": [ - { - "name": "customer_id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v2/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } - }, - { - "name": "email", - "in": "query", - "description": "Limit result set to resources with a specific email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "role", - "in": "query", - "description": "Limit result set to resources with a specific role.", - "required": false, - "schema": { - "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "required": true, "description": "New user email address." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "required": false, "description": "New user username." }, - "password": { "type": "string", "required": true, "description": "New user password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["email", "password"] - } - } - } - } - } - }, - "/wc/v2/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - }, - "reassign": { "type": "integer", "description": "ID to reassign posts to." } - } - } - } - } - } - } - }, - "/wc/v2/customers/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/notes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result to customers or internal notes.", - "required": false, - "schema": { "enum": ["any", "customer", "internal"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "note": { "type": "string", "required": true, "description": "Order note content." }, - "customer_note": { - "type": "boolean", - "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." - } - }, - "required": ["note"] - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/notes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "amount": { "type": "string", "description": "Refund amount." }, - "reason": { "type": "string", "description": "Reason for refund." }, - "refunded_by": { "type": "integer", "description": "User ID of user who created the refund." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "api_refund": { - "type": "boolean", - "description": "When true, the payment gateway API is used to generate the refund." - } - } - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/refunds/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders assigned a specific status.", - "required": false, - "schema": { - "enum": [ - "any", - "trash", - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ] - } - }, - { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - } - }, - "/wc/v2/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - } - }, - "/wc/v2/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "query", - "description": "Unique identifier for the variation.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "Unique identifier for the variation." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "email": { "type": "string", "required": true, "description": "Email of the reviewer." } - }, - "required": ["review", "name", "email"] - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/reviews/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/reviews/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - } - }, - "/wc/v2/products/shipping_classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/shipping_classes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/shipping_classes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/tags/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", "required": false, "schema": { "enum": [ "date", "id", "include", - "title", - "slug", "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" + "slug", + "title" ] } }, { - "name": "parent", + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", + "name": "filter", "required": false, "schema": {} }, { - "name": "status", + "description": "Limit result set to resources with a specific code.", "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "name": "code", "required": false, "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "in_stock", - "in": "query", - "description": "Limit result set to products in stock or out of stock.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } } - ] - }, - "post": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" } - }, + } + }, + "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": { + "description": "Coupon description.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } } }, - "/wc/v2/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], + "/wc/v1/coupons/batch": { + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "code": { + "description": "Coupon code.", + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": { + "description": "Coupon description.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } } }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/coupons/{id}": { + "delete": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -51911,107 +50660,71 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -52020,107 +50733,107 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "code": { + "description": "Coupon code.", + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": { + "description": "Coupon description.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, + "post": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -52129,697 +50842,17741 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "include", + "name", + "registered_date" + ] + } + }, + { + "description": "Limit result set to resources with a specific email.", + "in": "query", + "name": "email", + "required": false, + "schema": { + "format": "email" + } + }, + { + "description": "Limit result set to resources with a specific role.", + "in": "query", + "name": "role", + "required": false, + "schema": { + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "email", + "password" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers/batch": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers/{customer_id}/downloads": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "customer_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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "in": "query", + "name": "filter", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ] + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/notes": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "customer_note": { + "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" + } + }, + "required": [ + "note" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/notes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/refunds": { + "get": { + "parameters": [ + { + "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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "in": "query", + "name": "filter", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ] + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "Refund amount.", + "type": "string" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/refunds/{id}": { + "delete": { + "parameters": [ + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "in": "query", + "name": "filter", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific SKU.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/categories/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/shipping_classes": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/shipping_classes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/shipping_classes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/tags": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/tags/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/{product_id}/reviews": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "query", + "name": "id", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "required": [ + "email", + "name", + "review" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/{product_id}/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/reports/sales": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/reports/top_sellers": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes": { + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "order", + "priority" + ] + } + }, + { + "description": "Sort by tax class.", + "in": "query", + "name": "class", + "required": false, + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/classes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/classes/{slug}": { + "delete": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "title" + ] + } + }, + { + "description": "Limit result set to webhooks assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "delivery_url", + "topic" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/{webhook_id}/deliveries": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/{webhook_id}/deliveries/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v2/coupons": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to resources with a specific code.", + "in": "query", + "name": "code", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "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" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/coupons/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/coupons/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "include", + "name", + "registered_date" + ] + } + }, + { + "description": "Limit result set to resources with a specific email.", + "in": "query", + "name": "email", + "required": false, + "schema": { + "format": "email" + } + }, + { + "description": "Limit result set to resources with a specific role.", + "in": "query", + "name": "role", + "required": false, + "schema": { + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "email", + "password" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers/batch": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers/{customer_id}/downloads": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "customer_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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to orders assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ] + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/notes": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + }, + { + "description": "Limit result to customers or internal notes.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "customer_note": { + "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" + } + }, + "required": [ + "note" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/notes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/refunds": { + "get": { + "parameters": [ + { + "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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/refunds/{id}": { + "delete": { + "parameters": [ + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/payment_gateways": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/payment_gateways/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" }, "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "description": "Allow one item to be bought in a single order.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "status": { + "description": "Product status (post status).", + "type": "string" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" }, "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "description": "Allow one item to be bought in a single order.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "status": { + "description": "Product status (post status).", + "type": "string" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/categories/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "description": { + "description": "HTML description of the resource.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "display": { + "description": "Category archive display type.", + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "image": { + "description": "Image data.", + "type": "object" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "name": { + "description": "Category name.", + "type": "string" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/shipping_classes": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/shipping_classes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/shipping_classes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/tags": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/tags/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/reviews": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "query", + "name": "id", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "required": [ + "email", + "name", + "review" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/reviews/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/products/{product_id}/variations": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "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" + ] + } }, { - "name": "parent", - "in": "query", "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "parent_exclude", - "in": "query", "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" + } + } }, { - "name": "slug", - "in": "query", "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", "required": false, "schema": {} }, { - "name": "status", - "in": "query", "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { - "name": "type", - "in": "query", "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" + ] + } }, { - "name": "sku", - "in": "query", "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", "required": false, "schema": {} }, { - "name": "featured", - "in": "query", "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", "required": false, "schema": {} }, { - "name": "category", - "in": "query", "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", "required": false, "schema": {} }, { - "name": "tag", - "in": "query", "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", "required": false, "schema": {} }, { - "name": "shipping_class", - "in": "query", "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", "required": false, "schema": {} }, { - "name": "attribute", - "in": "query", "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", "required": false, "schema": {} }, { - "name": "attribute_term", - "in": "query", "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", "required": false, "schema": {} }, { - "name": "in_stock", - "in": "query", "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", "required": false, "schema": {} }, { - "name": "on_sale", - "in": "query", "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", "required": false, "schema": {} }, { - "name": "min_price", - "in": "query", "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", "required": false, "schema": {} }, { - "name": "max_price", - "in": "query", "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", "required": false, "schema": {} }, { - "name": "include_meta", - "in": "query", "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "exclude_meta", - "in": "query", "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/variations/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "exclude_meta", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "items": { + "type": "string" + } + } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", "in": "path", - "description": "Unique identifier for the variation.", + "name": "product_id", "required": true, "schema": {} } @@ -52828,305 +68585,162 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." + "description": { + "description": "Variation description.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "description": "Number of days until access to downloadable files expires.", + "type": "integer" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." + "download_limit": { + "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" }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", + "type": "boolean" }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "manage_stock": { + "description": "Stock management at variation level.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "meta_data": { + "description": "Meta data.", + "type": "array" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "regular_price": { + "description": "Variation regular price.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "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": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" } } - } + }, + "description": "OK" } } } }, "/wc/v2/products/{product_id}/variations/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", "required": true, "schema": {} } @@ -53135,83 +68749,322 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", "required": true, "schema": {} } @@ -53220,83 +69073,256 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/variations/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -53305,392 +69331,1051 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/reports/sales": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { - "name": "period", - "in": "query", "description": "Report period.", + "in": "query", + "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { - "name": "date_min", - "in": "query", "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" + } }, { - "name": "date_max", - "in": "query", "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" + } + } + }, + "description": "OK" + } + } } }, "/wc/v2/reports/top_sellers": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { - "name": "period", - "in": "query", "description": "Report period.", + "in": "query", + "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { - "name": "date_min", - "in": "query", "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" + } }, { - "name": "date_max", - "in": "query", "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" + } } - ] - } - }, - "/wc/v2/reports": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] + } } }, "/wc/v2/settings": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, + "description": "OK" } } } }, "/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": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] + } } }, "/wc/v2/settings/{group_id}/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" } } - } + }, + "description": "OK" } } } }, "/wc/v2/settings/{group_id}/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, { - "name": "id", - "in": "path", + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "group_id", "required": true, "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } } }, @@ -53698,403 +70383,487 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" } } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "required": true, "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, - "required": ["name"] + "required": [ + "name" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, + "delete": { "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } }, - "put": { + "get": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" } } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, + "post": { "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{id}/locations": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{zone_id}/methods": { "get": { + "parameters": [ + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} } - ] + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "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": { - "type": "object", "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." }, - "method_id": { "required": true, "description": "Shipping method ID." } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{zone_id}/methods/{instance_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, { - "name": "instance_id", + "description": "Unique ID for the zone.", "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, + { "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", "required": true, "schema": {} } @@ -54103,715 +70872,73 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/taxes/classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "name": { "type": "string", "required": true, "description": "Tax class name." } }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/taxes/classes/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", "properties": { "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" } - } - } - } - } - } - } - }, - "/wc/v2/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "order", "priority"] } - }, - { - "name": "class", - "in": "query", - "description": "Sort by tax class.", - "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v2/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v2/webhooks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "title"] } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to webhooks assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "required": true, "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - }, - "delivery_url": { "type": "string", "required": true, "description": "Webhook delivery URL." } }, - "required": ["topic", "delivery_url"] + "type": "object" } } } - } - } - }, - "/wc/v2/webhooks/{id}": { - "get": { + }, "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" } - }, + } + }, + "get": { "parameters": [ { - "name": "id", + "description": "Unique ID for the zone.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "zone_id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", + "description": "Unique ID for the instance.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "instance_id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" } } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, "parameters": [ { - "name": "id", + "description": "Unique ID for the zone.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "zone_id", + "required": true, + "schema": {} + }, + { + "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", "required": true, "schema": {} } @@ -54820,33 +70947,51 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, + "post": { "parameters": [ { - "name": "id", + "description": "Unique ID for the zone.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "zone_id", + "required": true, + "schema": {} + }, + { + "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", "required": true, "schema": {} } @@ -54855,415 +71000,246 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "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" } } } - } - } - }, - "/wc/v2/webhooks/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" } } - } + }, + "description": "OK" } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, + { + "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." + "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" } } } - } - }, - "patch": { + }, "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" } } - } - } - } - } - }, - "/wc/v2/webhooks/{webhook_id}/deliveries": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2/webhooks/{webhook_id}/deliveries/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2/system_status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v2/system_status/tools": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2/system_status/tools/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } + }, + "description": "OK" } } } }, "/wc/v2/shipping_methods": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" + } + } } }, "/wc/v2/shipping_methods/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } - ] - } - }, - "/wc/v2/payment_gateways": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] + } } }, - "/wc/v2/payment_gateways/{id}": { + "/wc/v2/system_status": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/system_status/tools": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/system_status/tools/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, + "patch": { "parameters": [ { - "name": "id", + "description": "A unique identifier for the tool.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "id", "required": true, "schema": {} } @@ -55272,31 +71248,14157 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes": { + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "order", + "priority" + ] + } + }, + { + "description": "Sort by tax class.", + "in": "query", + "name": "class", + "required": false, + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/classes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/classes/{slug}": { + "delete": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "title" + ] + } + }, + { + "description": "Limit result set to webhooks assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "delivery_url", + "topic" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/{webhook_id}/deliveries": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/{webhook_id}/deliveries/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/coupons": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to resources with a specific code.", + "in": "query", + "name": "code", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "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" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/coupons/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/coupons/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "include", + "name", + "registered_date" + ] + } + }, + { + "description": "Limit result set to resources with a specific email.", + "in": "query", + "name": "email", + "required": false, + "schema": { + "format": "email" + } + }, + { + "description": "Limit result set to resources with a specific role.", + "in": "query", + "name": "role", + "required": false, + "schema": { + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "email", + "password" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers/batch": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers/{customer_id}/downloads": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "customer_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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/continents": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/continents/{location}": { + "get": { + "parameters": [ + { + "description": "2 character continent code.", + "in": "query", + "name": "continent", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "location", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/countries": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/countries/{location}": { + "get": { + "parameters": [ + { + "description": "ISO3166 alpha-2 country code.", + "in": "path", + "name": "location", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/currencies": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/currencies/current": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/currencies/{currency}": { + "get": { + "parameters": [ + { + "description": "ISO4217 currency code.", + "in": "query", + "name": "location", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "currency", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/layout-templates": { + "get": { + "parameters": [ + { + "description": "Area to get templates for.", + "in": "query", + "name": "area", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/layout-templates/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/create-order": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "required": true + } + }, + "required": [ + "product_id" + ], + "type": "object" + } + } + } + }, + "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" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/subscriptions/connect": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/subscriptions/disconnect": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], + "type": "object" + } + } + } + }, + "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" + } + } + } + }, + "/wc/v3/orders": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to orders which have specific statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{id}/receipt": { + "get": { + "parameters": [ + { + "description": "Unique identifier of the order.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier of the order.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "force_new": { + "description": "True to force the creation of a new receipt even if one already exists and has not expired yet.", + "required": false, + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + }, + { + "description": "Limit result to customers or internal notes.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "added_by_user": { + "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.", + "type": "boolean" + }, + "customer_note": { + "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" + } + }, + "required": [ + "note" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{order_id}/notes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{order_id}/refunds": { + "get": { + "parameters": [ + { + "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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{order_id}/refunds/{id}": { + "delete": { + "parameters": [ + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/payment_gateways": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/payment_gateways/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "popularity", + "price", + "rating", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit results to those with a SKU that partially matches a string.", + "in": "query", + "name": "search_sku", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/categories/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/custom-fields/names": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": {} + }, + { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Order sort items ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/products/reviews": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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 reviews published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "description": "Ensure result set excludes reviews assigned to specific user IDs.", + "in": "query", + "name": "reviewer_exclude", + "required": false, + "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" + } + }, + { + "description": "Limit result set to reviews assigned to specific product IDs.", + "in": "query", + "name": "product", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to reviews assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "description": "Unique identifier for the product.", + "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" + } + }, + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/reviews/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes/slug-suggestion": { + "get": { + "parameters": [ + { + "description": "Shipping class name.", + "in": "query", + "name": "name", + "required": false, + "schema": {} + }, + { + "description": "An alphanumeric identifier for the resource unique to its type.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "HTML description of the resource.", + "in": "query", + "name": "description", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/suggested-products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to specific product categorie ids.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific product tag ids.", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific amount of suggested products.", + "in": "query", + "name": "limit", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/tags": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/tags/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{id}/duplicate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit result set to products with or without price.", + "in": "query", + "name": "has_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations/generate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/refunds": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/coupons/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupon_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/customers/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customer_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/orders/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_order_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/products/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_product_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/reviews/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_review_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/sales": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/top_sellers": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings/batch": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" } - }, + } + } + }, + "/wc/v3/settings/{group_id}": { + "get": { "parameters": [ { - "name": "id", + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "group_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings/{group_id}/batch": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", "required": true, "schema": {} } @@ -55305,31 +85407,194 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } + "group": { + "description": "Settings group ID.", + "type": "string" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings/{group_id}/{id}": { + "get": { + "parameters": [ + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", "required": true, "schema": {} } @@ -55338,11069 +85603,2966 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } + "group": { + "description": "Settings group ID.", + "type": "string" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } - } - }, - "/wc-telemetry": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc-telemetry/tracker": { + }, "post": { - "responses": { "200": { "description": "OK" } }, + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "platform": { "type": "string", "required": true, "description": "Platform to track." }, - "version": { "type": "string", "required": true, "description": "Platform version to track." }, - "installation_date": { - "type": "string", - "required": false, - "description": "Installation date of the WooCommerce mobile app." + "group": { + "description": "Settings group ID.", + "type": "string" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "required": ["platform", "version"] + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones/{id}": { + "delete": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones/{id}/locations": { + "get": { + "parameters": [ + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones/{zone_id}/methods": { + "get": { + "parameters": [ + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "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" + } + }, + "required": [ + "method_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping_methods": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping_methods/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/system_status": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/system_status/tools": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/system_status/tools/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes": { + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "order", + "priority" + ] + } + }, + { + "description": "Sort by tax class.", + "in": "query", + "name": "class", + "required": false, + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/classes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/classes/{slug}": { + "delete": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/webhooks": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "title" + ] + } + }, + { + "description": "Limit result set to webhooks assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "delivery_url", + "topic" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/webhooks/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/webhooks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } } } }, "/wccom-site/v3": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wccom-site/v3/installer": { - "post": { - "responses": { "200": { "description": "OK" } }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product-id": { "type": "integer", "required": true }, - "run-until-step": { "type": "string", "required": true }, - "idempotency-key": { "type": "string", "required": true } + "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" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } } }, "put": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product-id": { "type": "integer", "required": true }, - "run-until-step": { "type": "string", "required": true }, - "idempotency-key": { "type": "string", "required": true } + "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" } } } - } - }, - "patch": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product-id": { "type": "integer", "required": true }, - "run-until-step": { "type": "string", "required": true }, - "idempotency-key": { "type": "string", "required": true } - }, - "required": ["product-id", "run-until-step", "idempotency-key"] - } - } + }, + "responses": { + "200": { + "description": "OK" } } } }, "/wccom-site/v3/installer/reset": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product-id": { "type": "integer", "required": true }, - "idempotency-key": { "type": "string", "required": true } - }, - "required": ["product-id", "idempotency-key"] - } - } - } - } - }, - "put": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product-id": { "type": "integer", "required": true }, - "idempotency-key": { "type": "string", "required": true } - }, - "required": ["product-id", "idempotency-key"] - } - } - } - } - }, "patch": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product-id": { "type": "integer", "required": true }, - "idempotency-key": { "type": "string", "required": true } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"] - } - } - } - } - } - }, - "/wccom-site/v3/ssr": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wccom-site/v3/status": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/carbon-fields/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/carbon-fields/v1/posts/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/terms/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/users/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/comments/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/options": { - "get": { "responses": { "200": { "description": "OK" } } }, - "post": { "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": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "type", - "in": "query", - "description": "The requested type: ID or URL.", - "required": true, - "schema": {} - }, - { - "name": "value", - "in": "query", - "description": "The ID / URL of the attachment", - "required": true, - "schema": {} - } - ] - } - }, - "/carbon-fields/v1/block-renderer": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "The name of the block." }, - "content": { "type": "string", "required": true, "description": "The content of the block." }, - "post_id": { "type": "integer", "description": "ID of the post context." } - }, - "required": ["name", "content"] - } - } - } - } - } - }, - "/wp/v2": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp/v2/posts": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "required": [ + "idempotency-key", + "product-id" ], - "type": "string" + "type": "object" } } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "categories_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "tags", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "tags_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "sticky", - "in": "query", - "description": "Limit result set to items that are sticky.", - "required": false, - "schema": {} } - ] + }, + "responses": { + "200": { + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." + "idempotency-key": { + "required": true, + "type": "string" }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." + "product-id": { + "required": true, + "type": "integer" } - } - } - } - } - } - } - }, - "/wp/v2/posts/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/posts/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/posts/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/posts/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/posts/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/pages": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "menu_order", - "in": "query", - "description": "Limit result set to posts with a specific menu_order value.", - "required": false, - "schema": {} - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "menu_order" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to items with particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + }, + "required": [ + "idempotency-key", + "product-id" ], - "type": "string" + "type": "object" } } } - ] - }, - "post": { + }, "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/pages/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } + "description": "OK" } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." + "idempotency-key": { + "required": true, + "type": "string" }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/pages/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/pages/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/pages/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/pages/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/media": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to items with particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { "items": { "enum": ["inherit", "private", "trash"], "type": "string" } } - }, - { - "name": "media_type", - "in": "query", - "description": "Limit result set to attachments of a particular media type.", - "required": false, - "schema": { "enum": ["image", "video", "application"] } - }, - { - "name": "mime_type", - "in": "query", - "description": "Limit result set to attachments of a particular MIME type.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - } - }, - "/wp/v2/media/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/media/{id}/post-process": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the attachment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "action": { "type": "string", "required": true } }, - "required": ["action"] - } - } - } - } - } - }, - "/wp/v2/media/{id}/edit": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "src": { "type": "string", "required": true, "description": "URL to the edited image file." }, - "modifiers": { "type": "array", "description": "Array of image edits." }, - "rotation": { - "type": "integer", - "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead." - }, - "x": { - "type": "number", - "description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead." - }, - "y": { - "type": "number", - "description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead." - }, - "width": { - "type": "number", - "description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead." - }, - "height": { - "type": "number", - "description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead." + "product-id": { + "required": true, + "type": "integer" } }, - "required": ["src"] - } - } - } - } - } - }, - "/wp/v2/menu-items": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "menu_order" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "required": [ + "idempotency-key", + "product-id" ], - "type": "string" + "type": "object" } } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "menus", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "menus_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "menu_order", - "in": "query", - "description": "Limit result set to posts with a specific menu_order value.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } + "responses": { + "200": { + "description": "OK" } } } }, - "/wp/v2/menu-items/{id}": { + "/wccom-site/v3/ssr": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } + "description": "OK" } - }, + } + } + }, + "/wccom-site/v3/status": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-block-editor/v1": { + "get": { "parameters": [ { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, + "description": "", + "in": "query", + "name": "namespace", + "required": false, "schema": {} }, { + "description": "", + "in": "query", "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } + "description": "OK" } } } }, - "/wp/v2/menu-items/{id}/autosaves": { + "/wp-block-editor/v1/export": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-block-editor/v1/navigation-fallback": { "get": { "responses": { "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } - } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } + "application/json": { + "schema": { + "$ref": "#/components/schemas/navigation-fallback" } } - } + }, + "description": "OK" } } } }, - "/wp/v2/menu-items/{parent}/autosaves/{id}": { + "/wp-block-editor/v1/url-details": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } - } - } - }, "parameters": [ { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", + "description": "The URL to process.", + "in": "query", + "name": "url", "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/blocks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] + "format": "uri" } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - } - } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "wp_pattern_category", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "wp_pattern_category_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/blocks/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - }, - "delete": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } + "description": "OK" } } } }, - "/wp/v2/blocks/{parent}/revisions": { + "/wp-openapi/v1": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, "parameters": [ { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", + "description": "", "in": "query", - "description": "Offset the result set by a specific number of items.", + "name": "namespace", "required": false, "schema": {} }, { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", + "description": "", "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/blocks/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/blocks/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } + "description": "OK" } } } }, - "/wp/v2/blocks/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/templates/{parent}/revisions": { + "/wp-openapi/v1/schema": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, { - "name": "orderby", + "description": "", "in": "query", - "description": "Sort collection by object attribute.", + "name": "namespace", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/templates/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } } - ] - }, - "delete": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } + "description": "OK" } } } }, - "/wp/v2/templates/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - } - }, - "/wp/v2/templates/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/templates": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "wp_id", - "in": "query", - "description": "Limit to the specified post ID.", - "required": false, - "schema": {} - }, - { - "name": "area", - "in": "query", - "description": "Limit to the specified template part area.", - "required": false, - "schema": {} - }, - { - "name": "post_type", - "in": "query", - "description": "Post type for which to get the templates.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { - "type": "string", - "required": true, - "description": "Unique slug identifying the template." - }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - }, - "required": ["slug"] - } - } - } - } - } - }, - "/wp/v2/templates/lookup": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "slug", - "in": "query", - "description": "The slug of the template to get the fallback for", - "required": true, - "schema": {} - }, - { - "name": "is_custom", - "in": "query", - "description": "Indicates if a template is custom or part of the template hierarchy", - "required": false, - "schema": {} - }, - { - "name": "template_prefix", - "in": "query", - "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/templates/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/template-parts/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/template-parts/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/template-parts/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - } - }, - "/wp/v2/template-parts/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/template-parts": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "wp_id", - "in": "query", - "description": "Limit to the specified post ID.", - "required": false, - "schema": {} - }, - { - "name": "area", - "in": "query", - "description": "Limit to the specified template part area.", - "required": false, - "schema": {} - }, - { - "name": "post_type", - "in": "query", - "description": "Post type for which to get the templates.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { - "type": "string", - "required": true, - "description": "Unique slug identifying the template." - }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - }, - "required": ["slug"] - } - } - } - } - } - }, - "/wp/v2/template-parts/lookup": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "slug", - "in": "query", - "description": "The slug of the template to get the fallback for", - "required": true, - "schema": {} - }, - { - "name": "is_custom", - "in": "query", - "description": "Indicates if a template is custom or part of the template hierarchy", - "required": false, - "schema": {} - }, - { - "name": "template_prefix", - "in": "query", - "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/template-parts/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/global-styles/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/global-styles/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the global styles revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the global styles revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/global-styles/themes/{stylesheet}/variations": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "stylesheet", "in": "path", "description": "The theme identifier", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/global-styles/themes/{stylesheet}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "stylesheet", "in": "path", "description": "The theme identifier", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/global-styles/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "styles": { "type": ["object"], "description": "Global styles." }, - "settings": { "type": ["object"], "description": "Global settings." }, - "title": { "type": ["object", "string"], "description": "Title of the global styles variation." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "styles": { "type": ["object"], "description": "Global styles." }, - "settings": { "type": ["object"], "description": "Global settings." }, - "title": { "type": ["object", "string"], "description": "Title of the global styles variation." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "styles": { "type": ["object"], "description": "Global styles." }, - "settings": { "type": ["object"], "description": "Global settings." }, - "title": { "type": ["object", "string"], "description": "Title of the global styles variation." } - } - } - } - } - } - } - }, - "/wp/v2/navigation": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/navigation/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/font-families": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { "enum": ["id", "include"] } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - } - }, - "/wp/v2/font-families/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/font-families/{font_family_id}/font-faces": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { "enum": ["id", "include"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_face_settings": { - "type": "string", - "required": true, - "description": "font-face declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_face_settings"] - } - } - } - } - } - }, - "/wp/v2/font-families/{font_family_id}/font-faces/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the font face.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the font face.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/product": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "popularity", - "rating", - "popularity", - "rating" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - } - } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "product_cat", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "product_cat_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "product_tag", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "product_tag_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/product/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/product/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/product/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/types/{type}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } } - } - }, - "parameters": [ - { - "name": "type", - "in": "path", - "description": "An alphanumeric identifier for the post type.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/statuses": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/statuses/{status}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } } - } - }, - "parameters": [ - { - "name": "status", - "in": "path", - "description": "An alphanumeric identifier for the status.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/taxonomies": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit results to taxonomies associated with a specific post type.", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/taxonomies/{taxonomy}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } } - } - }, - "parameters": [ - { - "name": "taxonomy", - "in": "path", - "description": "An alphanumeric identifier for the taxonomy.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to terms assigned to a specific parent.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/menus": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/menus/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/wp_pattern_category": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/wp_pattern_category/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/product_cat": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to terms assigned to a specific parent.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/product_cat/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/product_tag": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/product_tag/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/users": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by user attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url"] } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to users with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "roles", - "in": "query", - "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "capabilities", - "in": "query", - "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "who", - "in": "query", - "description": "Limit result set to users who are considered authors.", - "required": false, - "schema": { "enum": ["authors"] } - }, - { - "name": "has_published_posts", - "in": "query", - "description": "Limit result set to users who have published posts.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": { - "post": "post", - "page": "page", - "attachment": "attachment", - "nav_menu_item": "nav_menu_item", - "wp_block": "wp_block", - "wp_template": "wp_template", - "wp_template_part": "wp_template_part", - "wp_global_styles": "wp_global_styles", - "wp_navigation": "wp_navigation", - "wp_font_family": "wp_font_family", - "wp_font_face": "wp_font_face", - "product": "product" - } - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "required": true, "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "required": true, "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { - "type": "string", - "required": true, - "description": "Password for the user (never included)." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["username", "email", "password"] - } - } - } - } - } - }, - "/wp/v2/users/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as users do not support binning." - }, - "reassign": { - "type": "integer", - "required": true, - "description": "Reassign the deleted user's posts and links to this user ID." - } - }, - "required": ["reassign"] - } - } - } - } - } - }, - "/wp/v2/users/me": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as users do not support binning." - }, - "reassign": { - "type": "integer", - "required": true, - "description": "Reassign the deleted user's posts and links to this user ID." - } - }, - "required": ["reassign"] - } - } - } - } - } - }, - "/wp/v2/users/{user_id}/application-passwords": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [{ "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "required": true, "description": "The name of the application password." } - }, - "required": ["name"] - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [{ "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wp/v2/users/{user_id}/application-passwords/introspect": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/users/{user_id}/application-passwords/{uuid}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "description": "The name of the application password." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "description": "The name of the application password." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "description": "The name of the application password." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/comments": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to comments published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_email", - "in": "query", - "description": "Limit result set to that from a specific author email. Requires authorisation.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to comments published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by comment attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "post", "parent", "type"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to comments of specific parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Ensure result set excludes specific parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to comments assigned to specific post IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to comments assigned a specific status. Requires authorisation.", - "required": false, - "schema": {} - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to comments assigned a specific type. Requires authorisation.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - } - }, - "/wp/v2/comments/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "password", - "in": "query", - "description": "The password for the parent post of the comment (if the post is password protected).", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." }, - "password": { - "type": "string", - "description": "The password for the parent post of the comment (if the post is password protected)." - } - } - } - } - } - } - } - }, - "/wp/v2/search": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search-result" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "type", - "in": "query", - "description": "Limit results to items of an object type.", - "required": false, - "schema": { "enum": ["post", "term", "post-format"] } - }, - { - "name": "subtype", - "in": "query", - "description": "Limit results to items of one or more object subtypes.", - "required": false, - "schema": { - "items": { - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag", "any"], - "type": "string" - } - } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wp/v2/block-renderer/{name}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } } - } - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Unique registered name for the block.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["edit"] } - }, - { - "name": "attributes", - "in": "query", - "description": "Attributes for the block.", - "required": false, - "schema": {} - }, - { - "name": "post_id", - "in": "query", - "description": "ID of the post context.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } } - } - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Unique registered name for the block.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "attributes": { "type": "object", "description": "Attributes for the block." }, - "post_id": { "type": "integer", "description": "ID of the post context." } - } - } - } - } - } - } - }, - "/wp/v2/block-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "namespace", "in": "query", "description": "Block namespace.", "required": false, "schema": {} } - ] - } - }, - "/wp/v2/block-types/{namespace}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "namespace", "in": "path", "description": "Block namespace.", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/block-types/{namespace}/{name}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } } - } - }, - "parameters": [ - { "name": "name", "in": "path", "description": "Block name.", "required": true, "schema": {} }, - { "name": "namespace", "in": "path", "description": "Block namespace.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/settings": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Site title." }, - "description": { "type": "string", "description": "Site tagline." }, - "url": { "type": "string", "description": "Site URL." }, - "email": { - "type": "string", - "description": "This address is used for admin purposes, like new user notification." - }, - "timezone": { "type": "string", "description": "A city in the same timezone as you." }, - "date_format": { "type": "string", "description": "A date format for all date strings." }, - "time_format": { "type": "string", "description": "A time format for all time strings." }, - "start_of_week": { - "type": "integer", - "description": "A day number of the week that the week should start on." - }, - "language": { "type": "string", "description": "WordPress locale code." }, - "use_smilies": { - "type": "boolean", - "description": "Convert emoticons like :-) and :-P to graphics on display." - }, - "default_category": { "type": "integer", "description": "Default post category." }, - "default_post_format": { "type": "string", "description": "Default post format." }, - "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, - "show_on_front": { "type": "string", "description": "What to show on the front page" }, - "page_on_front": { - "type": "integer", - "description": "The ID of the page that should be displayed on the front page" - }, - "page_for_posts": { - "type": "integer", - "description": "The ID of the page that should display the latest posts" - }, - "default_ping_status": { - "type": "string", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." - }, - "default_comment_status": { - "type": "string", - "description": "Allow people to submit comments on new posts." - }, - "site_logo": { "type": "integer", "description": "Site logo." }, - "site_icon": { "type": "integer", "description": "Site icon." }, - "pickup_location_settings": { - "type": "object", - "description": "WooCommerce Local Pickup Method Settings" - }, - "pickup_locations": { "type": "array", "description": "WooCommerce Local Pickup Locations" } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Site title." }, - "description": { "type": "string", "description": "Site tagline." }, - "url": { "type": "string", "description": "Site URL." }, - "email": { - "type": "string", - "description": "This address is used for admin purposes, like new user notification." - }, - "timezone": { "type": "string", "description": "A city in the same timezone as you." }, - "date_format": { "type": "string", "description": "A date format for all date strings." }, - "time_format": { "type": "string", "description": "A time format for all time strings." }, - "start_of_week": { - "type": "integer", - "description": "A day number of the week that the week should start on." - }, - "language": { "type": "string", "description": "WordPress locale code." }, - "use_smilies": { - "type": "boolean", - "description": "Convert emoticons like :-) and :-P to graphics on display." - }, - "default_category": { "type": "integer", "description": "Default post category." }, - "default_post_format": { "type": "string", "description": "Default post format." }, - "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, - "show_on_front": { "type": "string", "description": "What to show on the front page" }, - "page_on_front": { - "type": "integer", - "description": "The ID of the page that should be displayed on the front page" - }, - "page_for_posts": { - "type": "integer", - "description": "The ID of the page that should display the latest posts" - }, - "default_ping_status": { - "type": "string", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." - }, - "default_comment_status": { - "type": "string", - "description": "Allow people to submit comments on new posts." - }, - "site_logo": { "type": "integer", "description": "Site logo." }, - "site_icon": { "type": "integer", "description": "Site icon." }, - "pickup_location_settings": { - "type": "object", - "description": "WooCommerce Local Pickup Method Settings" - }, - "pickup_locations": { "type": "array", "description": "WooCommerce Local Pickup Locations" } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Site title." }, - "description": { "type": "string", "description": "Site tagline." }, - "url": { "type": "string", "description": "Site URL." }, - "email": { - "type": "string", - "description": "This address is used for admin purposes, like new user notification." - }, - "timezone": { "type": "string", "description": "A city in the same timezone as you." }, - "date_format": { "type": "string", "description": "A date format for all date strings." }, - "time_format": { "type": "string", "description": "A time format for all time strings." }, - "start_of_week": { - "type": "integer", - "description": "A day number of the week that the week should start on." - }, - "language": { "type": "string", "description": "WordPress locale code." }, - "use_smilies": { - "type": "boolean", - "description": "Convert emoticons like :-) and :-P to graphics on display." - }, - "default_category": { "type": "integer", "description": "Default post category." }, - "default_post_format": { "type": "string", "description": "Default post format." }, - "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, - "show_on_front": { "type": "string", "description": "What to show on the front page" }, - "page_on_front": { - "type": "integer", - "description": "The ID of the page that should be displayed on the front page" - }, - "page_for_posts": { - "type": "integer", - "description": "The ID of the page that should display the latest posts" - }, - "default_ping_status": { - "type": "string", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." - }, - "default_comment_status": { - "type": "string", - "description": "Allow people to submit comments on new posts." - }, - "site_logo": { "type": "integer", "description": "Site logo." }, - "site_icon": { "type": "integer", "description": "Site icon." }, - "pickup_location_settings": { - "type": "object", - "description": "WooCommerce Local Pickup Method Settings" - }, - "pickup_locations": { "type": "array", "description": "WooCommerce Local Pickup Locations" } - } - } - } - } - } - } - }, - "/wp/v2/themes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } } - } - }, - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Limit result set to themes assigned one or more statuses.", - "required": false, - "schema": { "items": { "enum": ["active", "inactive"], "type": "string" } } - } - ] - } - }, - "/wp/v2/themes/{stylesheet}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } } - } - }, - "parameters": [ - { - "name": "stylesheet", - "in": "path", - "description": "The theme's style sheet. This uniquely identifies the theme.", - "required": true, - "schema": {} - } - ] - } - }, - "/wp/v2/plugins": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limits results to plugins with the given status.", - "required": false, - "schema": { "items": { "type": "string", "enum": ["inactive", "active"] } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "required": true, "description": "WordPress.org plugin directory slug." }, - "status": { "type": "string", "description": "The plugin activation status." } - }, - "required": ["slug"] - } - } - } - } - } - }, - "/wp/v2/plugins/{plugin}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "status": { "type": "string", "description": "The plugin activation status." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "status": { "type": "string", "description": "The plugin activation status." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "status": { "type": "string", "description": "The plugin activation status." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - } - }, - "/wp/v2/sidebars": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/sidebars/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of a registered sidebar", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "widgets": { "type": "array", "description": "Nested widgets." } } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "widgets": { "type": "array", "description": "Nested widgets." } } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "widgets": { "type": "array", "description": "Nested widgets." } } - } - } - } - } - } - }, - "/wp/v2/widget-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/widget-types/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The widget type ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/widget-types/{id}/encode": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "id", "in": "path", "description": "The widget type ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "instance": { "type": "object", "description": "Current instance settings of the widget." }, - "form_data": { - "type": "string", - "description": "Serialised widget form data to encode into instance settings." - } - } - } - } - } - } - } - }, - "/wp/v2/widget-types/{id}/render": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "id", "in": "path", "description": "The widget type ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "instance": { "type": "object", "description": "Current instance settings of the widget." } - } - } - } - } - } - } - }, - "/wp/v2/widgets": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "sidebar", - "in": "query", - "description": "The sidebar for which to return widgets.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "string", "description": "Unique identifier for the widget." }, - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { - "type": "string", - "required": true, - "description": "The sidebar to which the widget belongs." - }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - }, - "required": ["sidebar"] - } - } - } - } - } - }, - "/wp/v2/widgets/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the widget.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { "type": "string", "description": "The sidebar to which the widget belongs." }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the widget.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { "type": "string", "description": "The sidebar to which the widget belongs." }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the widget.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { "type": "string", "description": "The sidebar to which the widget belongs." }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Whether to force removal of the widget, or move it to the inactive sidebar." - } - } - } - } - } - } - } - }, - "/wp/v2/block-directory/search": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-directory-item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "term", - "in": "query", - "description": "Limit result set to blocks matching the search term.", - "required": true, - "schema": { "minLength": 1 } - } - ] - } - }, - "/wp/v2/pattern-directory/patterns": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/pattern-directory-item" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": { "minLength": 1 } - }, - { - "name": "category", - "in": "query", - "description": "Limit results to those matching a category ID.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "keyword", - "in": "query", - "description": "Limit results to those matching a keyword ID.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "slug", - "in": "query", - "description": "Limit results to those matching a pattern (slug).", - "required": false, - "schema": {} - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "favorite_count" - ] - } - } - ] - } - }, - "/wp/v2/block-patterns/patterns": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern" } } } - } - } - } - }, - "/wp/v2/block-patterns/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern-category" } } - } - } - } - } - }, - "/wp/v2/menu-locations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/menu-locations/{location}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } } - } - }, - "parameters": [ - { - "name": "location", - "in": "path", - "description": "An alphanumeric identifier for the menu location.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/font-collections": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - } - ] - } - }, - "/wp/v2/font-collections/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "slug", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, "/wp-site-health/v1": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp-site-health/v1/tests/background-updates": { - "get": { + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } + "description": "OK" } } } }, - "/wp-site-health/v1/tests/loopback-requests": { + "/wp-site-health/v1/directory-sizes": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } - } - } - } - }, - "/wp-site-health/v1/tests/https-status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } - } - } - } - }, - "/wp-site-health/v1/tests/dotorg-communication": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } + "description": "OK" } } } @@ -66409,47 +88571,16886 @@ "get": { "responses": { "200": { - "description": "OK", - "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/directory-sizes": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wp-site-health/v1/tests/page-cache": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wp-block-editor/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp-block-editor/v1/url-details": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "url", - "in": "query", - "description": "The URL to process.", - "required": true, - "schema": { "format": "uri" } - } - ] - } - }, - "/wp-block-editor/v1/export": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wp-block-editor/v1/navigation-fallback": { + "/wp-site-health/v1/tests/background-updates": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/navigation-fallback" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/dotorg-communication": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/https-status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/loopback-requests": { + "get": { + "responses": { + "200": { + "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/v2": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/block-directory/search": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "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 result set to blocks matching the search term.", + "in": "query", + "name": "term", + "required": true, + "schema": { + "minLength": 1 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-directory-item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-patterns/categories": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-patterns/patterns": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-renderer/{name}": { + "get": { + "parameters": [ + { + "description": "Unique registered name for the block.", + "in": "path", + "name": "name", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit" + ] + } + }, + { + "description": "Attributes for the block.", + "in": "query", + "name": "attributes", + "required": false, + "schema": {} + }, + { + "description": "ID of the post context.", + "in": "query", + "name": "post_id", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique registered name for the block.", + "in": "path", + "name": "name", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-types": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Block namespace.", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-types/{namespace}": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Block namespace.", + "in": "path", + "name": "namespace", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", + "in": "query", + "name": "wp_pattern_category", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", + "in": "query", + "name": "wp_pattern_category_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/categories": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific parent.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/comments": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to comments published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + } + }, + { + "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", + "in": "query", + "name": "author_exclude", + "required": false, + "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" + } + }, + { + "description": "Limit response to comments published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by comment attribute.", + "in": "query", + "name": "orderby", + "required": false, + "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" + } + } + }, + { + "description": "Ensure result set excludes specific parent IDs.", + "in": "query", + "name": "parent_exclude", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to comments assigned a specific status. Requires authorisation.", + "in": "query", + "name": "status", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to comments assigned a specific type. Requires authorisation.", + "in": "query", + "name": "type", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/comments/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "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" + }, + "password": { + "description": "The password for the parent post of the comment (if the post is password protected).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "The password for the parent post of the comment (if the post is password protected).", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-collections": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-collections/{slug}": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families/{font_family_id}/font-faces": { + "get": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_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": [ + "edit", + "embed", + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "id", + "include" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_face_settings": { + "description": "font-face declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_face_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families/{font_family_id}/font-faces/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the font face.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the font face.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/themes/{stylesheet}": { + "get": { + "parameters": [ + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/themes/{stylesheet}/variations": { + "get": { + "parameters": [ + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/{id}": { + "get": { + "parameters": [ + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "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" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "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" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/{parent}/revisions/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the global styles revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the global styles revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/media": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit result set to posts assigned to specific authors.", + "in": "query", + "name": "author", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to items with particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to attachments of a particular media type.", + "in": "query", + "name": "media_type", + "required": false, + "schema": { + "enum": [ + "application", + "image", + "video" + ] + } + }, + { + "description": "Limit result set to attachments of a particular MIME type.", + "in": "query", + "name": "mime_type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/media/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/media/{id}/edit": { + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "height": { + "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" + }, + "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" + }, + "width": { + "description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead.", + "type": "number" + }, + "x": { + "description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead.", + "type": "number" + }, + "y": { + "description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead.", + "type": "number" + } + }, + "required": [ + "src" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/media/{id}/post-process": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the attachment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "action": { + "required": true, + "type": "string" + } + }, + "required": [ + "action" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "author", + "date", + "id", + "include", + "include_slugs", + "menu_order", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", + "in": "query", + "name": "menus", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", + "in": "query", + "name": "menus_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to posts with a specific menu_order value.", + "in": "query", + "name": "menu_order", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-locations": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-locations/{location}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the menu location.", + "in": "path", + "name": "location", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menus": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menus/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit result set to posts assigned to specific authors.", + "in": "query", + "name": "author", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to posts with a specific menu_order value.", + "in": "query", + "name": "menu_order", + "required": false, + "schema": {} + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "menu_order", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to items with particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pattern-directory/patterns": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": { + "minLength": 1 + } + }, + { + "description": "Limit results to those matching a category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Limit results to those matching a keyword ID.", + "in": "query", + "name": "keyword", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Limit results to those matching a pattern (slug).", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "favorite_count", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pattern-directory-item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/plugins": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limits results to plugins with the given status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "slug" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/plugins/{plugin}": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit result set to posts assigned to specific authors.", + "in": "query", + "name": "author", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", + "in": "query", + "name": "categories_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", + "in": "query", + "name": "tags_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items that are sticky.", + "in": "query", + "name": "sticky", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "popularity", + "popularity", + "rating", + "rating", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", + "in": "query", + "name": "product_cat", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", + "in": "query", + "name": "product_cat_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", + "in": "query", + "name": "product_tag", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", + "in": "query", + "name": "product_tag_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_cat": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific parent.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_cat/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_tag": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_tag/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/search": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results to items of an object type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "post", + "post-format", + "term" + ] + } + }, + { + "description": "Limit results to items of one or more object subtypes.", + "in": "query", + "name": "subtype", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], + "type": "string" + } + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search-result" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/settings": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "requestBody": { + "content": { + "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" + }, + "default_comment_status": { + "description": "Allow people to submit comments on new posts.", + "type": "string" + }, + "default_ping_status": { + "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" + }, + "email": { + "description": "This address is used for admin purposes, like new user notification.", + "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" + }, + "page_on_front": { + "description": "The ID of the page that should be displayed on the front page", + "type": "integer" + }, + "pickup_location_settings": { + "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" + }, + "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" + }, + "use_smilies": { + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "default_comment_status": { + "description": "Allow people to submit comments on new posts.", + "type": "string" + }, + "default_ping_status": { + "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" + }, + "email": { + "description": "This address is used for admin purposes, like new user notification.", + "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" + }, + "page_on_front": { + "description": "The ID of the page that should be displayed on the front page", + "type": "integer" + }, + "pickup_location_settings": { + "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" + }, + "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" + }, + "use_smilies": { + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "default_comment_status": { + "description": "Allow people to submit comments on new posts.", + "type": "string" + }, + "default_ping_status": { + "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" + }, + "email": { + "description": "This address is used for admin purposes, like new user notification.", + "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" + }, + "page_on_front": { + "description": "The ID of the page that should be displayed on the front page", + "type": "integer" + }, + "pickup_location_settings": { + "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" + }, + "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" + }, + "use_smilies": { + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/sidebars": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/sidebars/{id}": { + "get": { + "parameters": [ + { + "description": "The ID of a registered sidebar", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/statuses": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/statuses/{status}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the status.", + "in": "path", + "name": "status", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/tags": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/taxonomies": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit results to taxonomies associated with a specific post type.", + "in": "query", + "name": "type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/taxonomies/{taxonomy}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the taxonomy.", + "in": "path", + "name": "taxonomy", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit to the specified post ID.", + "in": "query", + "name": "wp_id", + "required": false, + "schema": {} + }, + { + "description": "Limit to the specified template part area.", + "in": "query", + "name": "area", + "required": false, + "schema": {} + }, + { + "description": "Post type for which to get the templates.", + "in": "query", + "name": "post_type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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.", + "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" + } + }, + "required": [ + "slug" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/lookup": { + "get": { + "parameters": [ + { + "description": "The slug of the template to get the fallback for", + "in": "query", + "name": "slug", + "required": true, + "schema": {} + }, + { + "description": "Indicates if a template is custom or part of the template hierarchy", + "in": "query", + "name": "is_custom", + "required": false, + "schema": {} + }, + { + "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", + "in": "query", + "name": "template_prefix", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{id}": { + "delete": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{id}/autosaves": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{parent}/revisions": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit to the specified post ID.", + "in": "query", + "name": "wp_id", + "required": false, + "schema": {} + }, + { + "description": "Limit to the specified template part area.", + "in": "query", + "name": "area", + "required": false, + "schema": {} + }, + { + "description": "Post type for which to get the templates.", + "in": "query", + "name": "post_type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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.", + "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" + } + }, + "required": [ + "slug" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/lookup": { + "get": { + "parameters": [ + { + "description": "The slug of the template to get the fallback for", + "in": "query", + "name": "slug", + "required": true, + "schema": {} + }, + { + "description": "Indicates if a template is custom or part of the template hierarchy", + "in": "query", + "name": "is_custom", + "required": false, + "schema": {} + }, + { + "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", + "in": "query", + "name": "template_prefix", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{id}": { + "delete": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{id}/autosaves": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{parent}/revisions": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/themes": { + "get": { + "parameters": [ + { + "description": "Limit result set to themes assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/themes/{stylesheet}": { + "get": { + "parameters": [ + { + "description": "The theme's style sheet. This uniquely identifies the theme.", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/types": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/types/{type}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the post type.", + "in": "path", + "name": "type", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by user attribute.", + "in": "query", + "name": "orderby", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to users who are considered authors.", + "in": "query", + "name": "who", + "required": false, + "schema": { + "enum": [ + "authors" + ] + } + }, + { + "description": "Limit result set to users who have published posts.", + "in": "query", + "name": "has_published_posts", + "required": false, + "schema": { + "items": { + "enum": { + "attachment": "attachment", + "nav_menu_item": "nav_menu_item", + "page": "page", + "post": "post", + "product": "product", + "wp_block": "wp_block", + "wp_font_face": "wp_font_face", + "wp_font_family": "wp_font_family", + "wp_global_styles": "wp_global_styles", + "wp_navigation": "wp_navigation", + "wp_template": "wp_template", + "wp_template_part": "wp_template_part" + }, + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "email", + "password", + "username" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/me": { + "delete": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as users do not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "Reassign the deleted user's posts and links to this user ID.", + "required": true, + "type": "integer" + } + }, + "required": [ + "reassign" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as users do not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "Reassign the deleted user's posts and links to this user ID.", + "required": true, + "type": "integer" + } + }, + "required": [ + "reassign" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/{user_id}/application-passwords": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/{user_id}/application-passwords/introspect": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types/{id}": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types/{id}/encode": { + "post": { + "parameters": [ + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "description": "Serialised widget form data to encode into instance settings.", + "type": "string" + }, + "instance": { + "description": "Current instance settings of the widget.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types/{id}/render": { + "post": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/widgets": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "The sidebar for which to return widgets.", + "in": "query", + "name": "sidebar", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "required": true, + "type": "string" + } + }, + "required": [ + "sidebar" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widgets/{id}": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Whether to force removal of the widget, or move it to the inactive sidebar.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the widget.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the widget.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the widget.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/wp_pattern_category": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/wp_pattern_category/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" } } } } - } + }, + "security": [], + "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" + } + ] } diff --git a/lib/stylelint.d.ts b/lib/stylelint.d.ts deleted file mode 100755 index e02b5ee7..00000000 --- a/lib/stylelint.d.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** - * Définition d'un groupe de Propriétés _CSS_ du plugin `stylelint-config-clean-order` pour _Stylelint_. - */ -export type stylelintconfigcleanorderpropertygroup = { - emptyLineBefore: "never" | "threshold"; - noEmptyLineBetween: boolean; - properties: string | array; -}; diff --git a/lib/wp-json-openapi.json b/lib/wp-json-openapi.json index b0df0736..11f08a0d 100755 --- a/lib/wp-json-openapi.json +++ b/lib/wp-json-openapi.json @@ -1,901 +1,18598 @@ { - "openapi": "3.1.0", - "info": { - "title": "Haiku Atelier API", - "description": "", - "version": "6.6.1", - "contact": { "name": "Haiku Atelier", "url": "https:/haikuatelier.fr.ddev.site", "email": "contact@gcch.fr" } - }, - "servers": [{ "url": "https:/haikuatelier.fr.ddev.site/wp-json" }], - "tags": [ - { "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": "" } - ], - "security": [], "components": { "schemas": { - "shop_coupon": { + "Count Low in Stock Items": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shop_coupon", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the object.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true + "properties": { + "total": "integer" }, - "code": { "description": "Coupon code.", "type": "string", "context": ["view", "edit"] }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "context": ["view", "edit"] + "type": "object" + }, + "title": "Count Low in Stock Items", + "type": "object" + }, + "Install Async Schema": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "properties": { + "job_id": "integer", + "status": { + "enum": [ + "complete", + "failed", + "pending" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "Install Async Schema", + "type": "object" + }, + "Install and Activate Schema": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "properties": { + "activate": { + "properties": { + "activated": { + "items": { + "type": "string" + }, + "type": "array" + }, + "active": { + "items": { + "type": "string" + }, + "type": "array" + }, + "errors": { + "properties": { + "error_data": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + }, + "errors": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "install": { + "properties": { + "errors": { + "properties": { + "error_data": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + }, + "errors": { + "items": { + "type": "string" + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "installed": { + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "title": "Install and Activate Schema", + "type": "object" + }, + "ai/business-description": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/business-description", + "type": "object" + }, + "ai/images": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/images", + "type": "object" + }, + "ai/patterns": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/patterns", + "type": "object" + }, + "ai/product": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/product", + "type": "object" + }, + "ai/products": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/products", + "type": "object" + }, + "ai/store-info": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/store-info", + "type": "object" + }, + "ai/store-title": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "ai/store-title", + "type": "object" + }, + "application-password": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "app_id": { + "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": [ + "edit", + "view" + ], + "description": "The GMT date the application password was created.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "last_ip": { + "context": [ + "edit", + "view" + ], + "description": "The IP address the application password was last used by.", + "format": "ip", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "last_used": { + "context": [ + "edit", + "view" + ], + "description": "The GMT date the application password was last used.", + "format": "date-time", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The name of the application password.", + "minLength": 1, + "pattern": ".*\\S.*", + "required": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "The generated password. Only available after adding an application.", + "readonly": true, + "type": "string" + }, + "uuid": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The unique identifier for the application password.", + "format": "uuid", + "readonly": true, + "type": "string" + } + }, + "title": "application-password", + "type": "object" + }, + "attachment": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "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" + }, + "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" + }, + "title": "The current user can change the author on this post." + } + ], + "properties": { + "alt_text": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Alternative text to display when attachment is not displayed.", + "type": "string" + }, + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the post.", + "type": "integer" + }, + "caption": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The attachment caption.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Caption for the attachment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML caption for the attachment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "comment_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "The attachment description.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Description for the attachment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML description for the attachment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "media_details": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Details about the media file, specific to its type.", + "readonly": true, + "type": "object" + }, + "media_type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Attachment type.", + "enum": [ + "file", + "image" + ], + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "mime_type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The attachment MIME type.", + "readonly": true, + "type": "string" + }, + "missing_image_sizes": { + "context": [ + "edit" + ], + "description": "List of the missing image sizes of the attachment.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "ping_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "post": { + "context": [ + "edit", + "view" + ], + "description": "The ID for the associated post of the attachment.", + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "source_url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the original attachment file.", + "format": "uri", + "readonly": true, + "type": "string" }, "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "context": ["view", "edit"] + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" }, - "date_created": { - "description": "The date the coupon was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" }, - "date_created_gmt": { - "description": "The date the coupon was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the coupon was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the coupon was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "default": "fixed_cart", - "enum": ["percent", "fixed_cart", "fixed_product"], - "context": ["view", "edit"] - }, - "description": { "description": "Coupon description.", "type": "string", "context": ["view", "edit"] }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "usage_count": { - "description": "Number of times the coupon has been used already.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "context": ["view", "edit"] - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "context": ["view", "edit"] - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "context": ["view", "edit"] - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "context": ["view", "edit"] - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "context": ["view", "edit"] - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"] - }, - "used_by": { - "description": "List of user IDs (or guest email addresses) that have used the coupon.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" } - } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" } - } + }, + "title": "attachment", + "type": "object" }, "batch": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "batch", - "type": "object", "properties": { "create": { + "context": [ + "edit", + "view" + ], "description": "List of created resources.", - "type": "array", - "context": ["view", "edit"], - "items": { "type": "object" } - }, - "update": { - "description": "List of updated resources.", - "type": "array", - "context": ["view", "edit"], - "items": { "type": "object" } + "items": { + "type": "object" + }, + "type": "array" }, "delete": { + "context": [ + "edit", + "view" + ], "description": "List of deleted resources.", - "type": "array", - "context": ["view", "edit"], - "items": { "type": "integer" } + "items": { + "type": "integer" + }, + "type": "array" + }, + "update": { + "context": [ + "edit", + "view" + ], + "description": "List of updated resources.", + "items": { + "type": "object" + }, + "type": "array" } - } + }, + "title": "batch", + "type": "object" }, - "customer_download": { + "block-directory-item": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "customer_download", - "type": "object", "properties": { - "download_id": { "description": "Download ID.", "type": "string", "context": ["view"], "readonly": true }, - "download_url": { - "description": "Download file URL.", - "type": "string", - "context": ["view"], - "readonly": true + "active_installs": { + "context": [ + "view" + ], + "description": "The number of sites that have activated this block.", + "type": "integer" }, - "product_id": { - "description": "Downloadable product ID.", - "type": "integer", - "context": ["view"], - "readonly": true + "author": { + "context": [ + "view" + ], + "description": "The WordPress.org username of the block author.", + "type": "string" }, - "product_name": { "description": "Product name.", "type": "string", "context": ["view"], "readonly": true }, - "download_name": { - "description": "Downloadable file name.", - "type": "string", - "context": ["view"], - "readonly": true + "author_block_count": { + "context": [ + "view" + ], + "description": "The number of blocks published by the same author.", + "type": "integer" }, - "order_id": { "description": "Order ID.", "type": "integer", "context": ["view"], "readonly": true }, - "order_key": { "description": "Order key.", "type": "string", "context": ["view"], "readonly": true }, - "downloads_remaining": { - "description": "Number of downloads remaining.", - "type": "string", - "context": ["view"], - "readonly": true + "author_block_rating": { + "context": [ + "view" + ], + "description": "The average rating of blocks published by the same author.", + "type": "number" }, - "access_expires": { - "description": "The date when download access expires, in the site's timezone.", - "type": "string", - "context": ["view"], - "readonly": true + "description": { + "context": [ + "view" + ], + "description": "A short description of the block, in human readable format.", + "type": "string" }, - "access_expires_gmt": { - "description": "The date when download access expires, as GMT.", - "type": "string", - "context": ["view"], - "readonly": true + "humanized_updated": { + "context": [ + "view" + ], + "description": "The date when the block was last updated, in fuzzy human readable format.", + "type": "string" }, - "file": { - "description": "File details.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "name": { "description": "File name.", "type": "string", "context": ["view"], "readonly": true }, - "file": { "description": "File URL.", "type": "string", "context": ["view"], "readonly": true } - } + "icon": { + "context": [ + "view" + ], + "description": "The block icon.", + "format": "uri", + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "The block slug.", + "type": "string" + }, + "last_updated": { + "context": [ + "view" + ], + "description": "The date when the block was last updated.", + "format": "date-time", + "type": "string" + }, + "name": { + "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" + }, + "title": { + "context": [ + "view" + ], + "description": "The block title, in human readable format.", + "type": "string" } - } + }, + "title": "block-directory-item", + "type": "object" + }, + "block-pattern": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "block_types": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Block types that the pattern is intended to be used with.", + "readonly": true, + "type": "array" + }, + "categories": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern's category slugs.", + "readonly": true, + "type": "array" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern content.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern detailed description.", + "readonly": true, + "type": "string" + }, + "inserter": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Determines whether the pattern is visible in inserter.", + "readonly": true, + "type": "boolean" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern keywords.", + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern name.", + "readonly": true, + "type": "string" + }, + "post_types": { + "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": [ + "edit", + "embed", + "view" + ], + "description": "Where the pattern comes from e.g. core", + "enum": [ + "core", + "pattern-directory/core", + "pattern-directory/featured", + "pattern-directory/theme", + "plugin", + "theme" + ], + "readonly": true, + "type": "string" + }, + "template_types": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An array of template types where the pattern fits.", + "readonly": true, + "type": "array" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern title, in human readable format.", + "readonly": true, + "type": "string" + }, + "viewport_width": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern viewport width for inserter preview.", + "readonly": true, + "type": "number" + } + }, + "title": "block-pattern", + "type": "object" + }, + "block-pattern-category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The category description in a human-readable format.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The category label, in human readable format.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The category name.", + "readonly": true, + "type": "string" + } + }, + "title": "block-pattern-category", + "type": "object" + }, + "block-type": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "allowed_blocks": { + "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" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "ancestor": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Ancestor blocks.", + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "api_version": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 1, + "description": "Version of block API.", + "readonly": true, + "type": "integer" + }, + "attributes": { + "additionalProperties": { + "type": "object" + }, + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block attributes.", + "properties": [], + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "block_hooks": { + "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": [ + "after", + "before", + "first_child", + "last_child" + ], + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "category": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block category.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of block type.", + "readonly": true, + "type": "string" + }, + "editor_script": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Editor script handle. DEPRECATED: Use `editor_script_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "editor_script_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Editor script handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "editor_style": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Editor style handle. DEPRECATED: Use `editor_style_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "editor_style_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Editor style handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "example": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block example.", + "properties": { + "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" + }, + "innerBlocks": { + "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", + "type": "array" + }, + "name": { + "description": "The name of the inner block.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "icon": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Icon of block type.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "is_dynamic": { + "context": [ + "edit", + "embed", + "view" + ], + "default": false, + "description": "Is the block dynamically rendered.", + "readonly": true, + "type": "boolean" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block keywords.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique name identifying the block type.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "readonly": true, + "required": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Parent blocks.", + "items": { + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "type": "string" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "provides_context": { + "additionalProperties": { + "type": "string" + }, + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Context provided by blocks of this type.", + "properties": [], + "readonly": true, + "type": "object" + }, + "script": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "script_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public facing and editor script handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "selectors": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Custom CSS selectors.", + "properties": [], + "readonly": true, + "type": "object" + }, + "style": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "style_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public facing and editor style handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "styles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block style variations.", + "items": { + "properties": { + "inline_style": { + "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" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "supports": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block supports.", + "properties": [], + "readonly": true, + "type": "object" + }, + "textdomain": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public text domain.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of block type.", + "readonly": true, + "type": "string" + }, + "uses_context": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Context values inherited by blocks of this type.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "variations": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block variations.", + "items": { + "properties": { + "attributes": { + "description": "The initial values for attributes.", + "type": "object" + }, + "category": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block category.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "A detailed variation description.", + "required": false, + "type": "string" + }, + "example": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Block example.", + "properties": { + "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" + }, + "innerBlocks": { + "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", + "type": "array" + }, + "name": { + "description": "The name of the inner block.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "icon": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Icon of block type.", + "readonly": true, + "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" + }, + "innerBlocks": { + "description": "A list of the inner block's own inner blocks. This is a recursive definition following the parent innerBlocks schema.", + "type": "array" + }, + "name": { + "description": "The name of the inner block.", + "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "isDefault": { + "default": false, + "description": "Indicates whether the current variation is the default one.", + "required": false, + "type": "boolean" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Block keywords.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "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" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "title": { + "description": "A human-readable variation title.", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "view_script": { + "context": [ + "edit", + "embed", + "view" + ], + "default": null, + "description": "Public facing script handle. DEPRECATED: Use `view_script_handles` instead.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "view_script_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public facing script handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "view_script_module_ids": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public-facing script module IDs.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + }, + "view_style_handles": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Public-facing style handles.", + "items": { + "type": "string" + }, + "readonly": true, + "type": [ + "array" + ] + } + }, + "title": "block-type", + "type": "object" + }, + "cart": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set billing address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "List of applied basket coupons.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount applied by this coupon.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount applied by this coupon.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "cross_sells": { + "context": [ + "edit", + "view" + ], + "description": "List of cross-sells items related to basket items.", + "items": { + "properties": { + "add_to_cart": { + "context": [ + "edit", + "view" + ], + "description": "Add to basket button parameters.", + "properties": { + "description": { + "context": [ + "edit", + "view" + ], + "description": "Button description.", + "readonly": true, + "type": "string" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity that can be added to the basket.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity that can be added to the basket.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "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": [ + "edit", + "view" + ], + "description": "Button text.", + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "edit", + "view" + ], + "description": "Add to basket URL.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "attributes": { + "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": [ + "edit", + "view" + ], + "description": "True if this attribute is used by product variations.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "The attribute name.", + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "The attribute taxonomy, or null if the attribute is not taxonomy based.", + "readonly": true, + "type": "string" + }, + "terms": { + "context": [ + "edit", + "view" + ], + "description": "List of assigned attribute terms.", + "items": { + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "If this is a default attribute", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The term ID, or 0 if the attribute is not a global attribute.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "The term name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "The term slug.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "average_rating": { + "context": [ + "edit", + "view" + ], + "description": "Reviews average rating.", + "readonly": true, + "type": "string" + }, + "categories": { + "context": [ + "edit", + "view" + ], + "description": "List of categories, if applicable.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID", + "readonly": true, + "type": "number" + }, + "link": { + "context": [ + "edit", + "view" + ], + "description": "Category link", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Category slug", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, + "has_options": { + "context": [ + "edit", + "view" + ], + "description": "Does the product have additional options before it can be added to the basket?", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "readonly": true, + "type": "string" + }, + "sizes": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "readonly": true, + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "readonly": true, + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "is_in_stock": { + "context": [ + "edit", + "view" + ], + "description": "Is the product in stock?", + "readonly": true, + "type": "boolean" + }, + "is_on_backorder": { + "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": [ + "edit", + "view" + ], + "description": "Is the product purchasable?", + "readonly": true, + "type": "boolean" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "on_sale": { + "context": [ + "edit", + "view" + ], + "description": "Is the product on sale?", + "readonly": true, + "type": "boolean" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "ID of the parent product, if applicable.", + "readonly": true, + "type": "integer" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "price_html": { + "context": [ + "edit", + "view" + ], + "description": "Price string formatted as HTML.", + "readonly": true, + "type": "string" + }, + "prices": { + "context": [ + "edit", + "view" + ], + "description": "Price data provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "review_count": { + "context": [ + "edit", + "view" + ], + "description": "Amount of reviews that the product has.", + "readonly": true, + "type": "integer" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Product slug.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "List of tags, if applicable.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tag ID", + "readonly": true, + "type": "number" + }, + "link": { + "context": [ + "edit", + "view" + ], + "description": "Tag link", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tag name", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Tag slug", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Product type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Product variation attributes, if applicable.", + "readonly": true, + "type": "string" + }, + "variations": { + "context": [ + "edit", + "view" + ], + "description": "List of variation IDs, if applicable.", + "items": { + "properties": { + "attributes": { + "context": [ + "edit", + "view" + ], + "description": "List of variation attributes.", + "items": { + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "The attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "The assigned attribute.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "errors": { + "context": [ + "edit", + "view" + ], + "description": "List of basket item errors, for example, items in the basket which are out of stock.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Error code", + "readonly": true, + "type": "string" + }, + "message": { + "context": [ + "edit", + "view" + ], + "description": "Error message", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, + "fees": { + "context": [ + "edit", + "view" + ], + "description": "List of basket fees.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the fee within the basket.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Fee total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Total amount for this fee.", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax amount for this fee.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "has_calculated_shipping": { + "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": [ + "edit", + "view" + ], + "description": "List of basket items.", + "items": { + "properties": { + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "True if backorders are allowed past stock availability.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "catalog_visibility": { + "context": [ + "edit", + "view" + ], + "description": "Whether the product is visible in the catalogue", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The item product or variation ID.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "readonly": true, + "type": "string" + }, + "sizes": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "readonly": true, + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "readonly": true, + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "item_data": { + "context": [ + "edit", + "view" + ], + "description": "Metadata related to the item", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Optionally, how the metadata value should be displayed to the user.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the metadata.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Value of the metadata.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item.", + "readonly": true, + "type": "string" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "prices": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "raw_prices": { + "context": [ + "edit", + "view" + ], + "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", + "properties": { + "precision": { + "context": [ + "edit", + "view" + ], + "description": "Decimal precision of the returned prices.", + "readonly": true, + "type": "integer" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of this item.", + "readonly": true, + "type": "number" + }, + "quantity_limits": { + "context": [ + "edit", + "view" + ], + "description": "How the quantity of this item should be controlled, for example, any limits in place.", + "properties": { + "editable": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "If the quantity is editable or fixed.", + "readonly": true, + "type": "boolean" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "show_backorder_badge": { + "context": [ + "edit", + "view" + ], + "description": "True if the product is on backorder.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Stock keeping unit, if applicable.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "Item total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "line_subtotal": { + "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": [ + "edit", + "view" + ], + "description": "Line subtotal tax.", + "readonly": true, + "type": "string" + }, + "line_total": { + "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": [ + "edit", + "view" + ], + "description": "Line total tax.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "items_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of items in the basket.", + "readonly": true, + "type": "integer" + }, + "items_weight": { + "context": [ + "edit", + "view" + ], + "description": "Total weight (in grams) of all products in the basket.", + "readonly": true, + "type": "number" + }, + "needs_payment": { + "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": [ + "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": [ + "edit", + "view" + ], + "description": "List of available payment method IDs that can be used to process the order.", + "readonly": true, + "type": "array" + }, + "payment_requirements": { + "context": [ + "edit", + "view" + ], + "description": "List of required payment gateway features to process the order.", + "readonly": true, + "type": "array" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set shipping address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "shipping_rates": { + "context": [ + "edit", + "view" + ], + "description": "List of available shipping rates for the basket.", + "items": { + "properties": { + "destination": { + "context": [ + "edit", + "view" + ], + "description": "Shipping destination address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "First line of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Second line of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "ISO code for the country of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Zip or Postcode of the address being shipped to.", + "readonly": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code, or name, for the state, province, or district of the address being shipped to.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "items": { + "context": [ + "edit", + "view" + ], + "description": "List of basket items the returned shipping rates apply to.", + "items": { + "properties": { + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item within the basket.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the item.", + "readonly": true, + "type": "string" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of the item in the current package.", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the package.", + "readonly": true, + "type": "string" + }, + "package_id": { + "context": [ + "edit", + "view" + ], + "description": "The ID of the package the shipping rates belong to.", + "readonly": true, + "type": [ + "integer", + "string" + ] + }, + "shipping_rates": { + "context": [ + "edit", + "view" + ], + "description": "List of shipping rates.", + "items": { + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "delivery_time": { + "context": [ + "edit", + "view" + ], + "description": "Delivery time estimate text, e.g. 3-5 business days.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Description of the shipping rate, e.g. Dispatched via Royal Mail.", + "readonly": true, + "type": "string" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Instance ID of the shipping method that provided the rate.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data attached to the shipping rate.", + "items": { + "properties": { + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "ID of the shipping method that provided the rate.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the shipping rate, e.g. Express shipping.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Price of this shipping rate using the smallest unit of the currency.", + "readonly": true, + "type": "string" + }, + "rate_id": { + "context": [ + "edit", + "view" + ], + "description": "ID of the shipping rate.", + "readonly": true, + "type": "string" + }, + "selected": { + "context": [ + "edit", + "view" + ], + "description": "True if this is the rate currently selected by the customer for the basket.", + "readonly": true, + "type": "boolean" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Taxes applied to this shipping rate using the smallest unit of the currency.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Basket total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Lines of taxes applied to items and shipping.", + "items": { + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "The name of the tax.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "The amount of tax charged.", + "readonly": true, + "type": "string" + }, + "rate": { + "context": [ + "edit", + "view" + ], + "description": "The rate at which tax is applied.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_fees": { + "context": [ + "edit", + "view" + ], + "description": "Total price of any applied fees.", + "readonly": true, + "type": "string" + }, + "total_fees_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on fees.", + "readonly": true, + "type": "string" + }, + "total_items": { + "context": [ + "edit", + "view" + ], + "description": "Total price of items in the basket.", + "readonly": true, + "type": "string" + }, + "total_items_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on items in the basket.", + "readonly": true, + "type": "string" + }, + "total_price": { + "context": [ + "edit", + "view" + ], + "description": "Total price the customer will pay.", + "readonly": true, + "type": "string" + }, + "total_shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total price of shipping. If shipping has not been calculated, a null response will be sent.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax applied to items and shipping.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "cart", + "type": "object" + }, + "cart-extensions": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "cart-extensions", + "type": "object" + }, + "cart_coupon": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount applied by this coupon.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount applied by this coupon.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "cart_coupon", + "type": "object" + }, + "cart_item": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "True if backorders are allowed past stock availability.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "catalog_visibility": { + "context": [ + "edit", + "view" + ], + "description": "Whether the product is visible in the catalogue", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "type": "object" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The item product or variation ID.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "item_data": { + "context": [ + "edit", + "view" + ], + "description": "Metadata related to the item", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Optionally, how the metadata value should be displayed to the user.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the metadata.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Value of the metadata.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item.", + "readonly": true, + "type": "string" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "prices": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "raw_prices": { + "context": [ + "edit", + "view" + ], + "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", + "properties": { + "precision": { + "context": [ + "edit", + "view" + ], + "description": "Decimal precision of the returned prices.", + "readonly": true, + "type": "integer" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of this item.", + "readonly": true, + "type": "number" + }, + "quantity_limits": { + "context": [ + "edit", + "view" + ], + "description": "How the quantity of this item should be controlled, for example, any limits in place.", + "properties": { + "editable": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "If the quantity is editable or fixed.", + "readonly": true, + "type": "boolean" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "show_backorder_badge": { + "context": [ + "edit", + "view" + ], + "description": "True if the product is on backorder.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Stock keeping unit, if applicable.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "Item total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "line_subtotal": { + "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": [ + "edit", + "view" + ], + "description": "Line subtotal tax.", + "readonly": true, + "type": "string" + }, + "line_total": { + "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": [ + "edit", + "view" + ], + "description": "Line total tax.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "title": "cart_item", + "type": "object" + }, + "category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "category" + ], + "readonly": true, + "type": "string" + } + }, + "title": "category", + "type": "object" + }, + "checkout": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "additional_fields": { + "context": [ + "edit", + "view" + ], + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "create_account": { + "context": [ + "edit", + "view" + ], + "description": "Whether to create a new user account as part of order processing.", + "type": "boolean" + }, + "customer_id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID if registered. Will return 0 for guests.", + "readonly": true, + "type": "integer" + }, + "customer_note": { + "context": [ + "edit", + "view" + ], + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": "object" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID to process during checkout.", + "readonly": true, + "type": "integer" + }, + "order_key": { + "context": [ + "edit", + "view" + ], + "description": "Order key used to check validity or protect access to certain order data.", + "readonly": true, + "type": "string" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order number used for display.", + "readonly": true, + "type": "string" + }, + "payment_method": { + "context": [ + "edit", + "view" + ], + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "type": "string" + }, + "payment_result": { + "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" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "payment_status": { + "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", + "readonly": true, + "type": "string" + }, + "redirect_url": { + "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status. Payment providers will update this value after payment.", + "readonly": true, + "type": "string" + } + }, + "title": "checkout", + "type": "object" + }, + "checkout-order": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "additional_fields": { + "context": [ + "edit", + "view" + ], + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "customer_id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID if registered. Will return 0 for guests.", + "readonly": true, + "type": "integer" + }, + "customer_note": { + "context": [ + "edit", + "view" + ], + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": "object" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID to process during checkout.", + "readonly": true, + "type": "integer" + }, + "order_key": { + "context": [ + "edit", + "view" + ], + "description": "Order key used to check validity or protect access to certain order data.", + "readonly": true, + "type": "string" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order number used for display.", + "readonly": true, + "type": "string" + }, + "payment_method": { + "context": [ + "edit", + "view" + ], + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "type": "string" + }, + "payment_result": { + "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" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "payment_status": { + "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", + "readonly": true, + "type": "string" + }, + "redirect_url": { + "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status. Payment providers will update this value after payment.", + "readonly": true, + "type": "string" + } + }, + "title": "checkout-order", + "type": "object" + }, + "comment": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_avatar_urls": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URLs for the comment author.", + "properties": { + "24": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 24 pixels.", + "format": "uri", + "type": "string" + }, + "48": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 48 pixels.", + "format": "uri", + "type": "string" + }, + "96": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 96 pixels.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "author_email": { + "context": [ + "edit" + ], + "description": "Email address for the comment author.", + "format": "email", + "type": "string" + }, + "author_ip": { + "context": [ + "edit" + ], + "description": "IP address for the comment author.", + "format": "ip", + "type": "string" + }, + "author_name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Display name for the comment author.", + "type": "string" + }, + "author_url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL for the comment author.", + "format": "uri", + "type": "string" + }, + "author_user_agent": { + "context": [ + "edit" + ], + "description": "User agent for the comment author.", + "type": "string" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The content for the comment.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Content for the comment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the comment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the comment was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the comment.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the comment.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 0, + "description": "The ID for the parent of the comment.", + "type": "integer" + }, + "post": { + "context": [ + "edit", + "view" + ], + "default": 0, + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "State of the comment.", + "type": "string" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of the comment.", + "readonly": true, + "type": "string" + } + }, + "title": "comment", + "type": "object" }, "customer": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "customer", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true + "avatar_url": { + "context": [ + "edit", + "view" + ], + "description": "Avatar URL.", + "readonly": true, + "type": "string" + }, + "billing": { + "context": [ + "edit", + "view" + ], + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "type": "object" }, "date_created": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "date_created_gmt": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "date_modified": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "date_modified_gmt": { + "context": [ + "edit", + "view" + ], "description": "The date the customer was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "date-time" }, "email": { + "context": [ + "edit", + "view" + ], "description": "The email address for the customer.", - "type": "string", "format": "email", - "context": ["view", "edit"] + "type": "string" }, - "first_name": { "description": "Customer first name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Customer last name.", "type": "string", "context": ["view", "edit"] }, - "role": { "description": "Customer role.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "username": { "description": "Customer login name.", "type": "string", "context": ["view", "edit"] }, - "password": { "description": "Customer password.", "type": "string", "context": ["edit"] }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { "description": "ISO code of the country.", "type": "string", "context": ["view", "edit"] }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": ["view", "edit"] - }, - "phone": { "description": "Phone number.", "type": "string", "context": ["view", "edit"] } - } + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer first name.", + "type": "string" }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { "description": "ISO code of the country.", "type": "string", "context": ["view", "edit"] } - } + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, "is_paying_customer": { + "context": [ + "edit", + "view" + ], "description": "Is the customer a paying customer?", - "type": "bool", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "bool" }, - "orders_count": { - "description": "Quantity of orders made by the customer.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total_spent": { - "description": "Total amount spent.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "avatar_url": { - "description": "Avatar URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Customer last name.", + "type": "string" }, "meta_data": { + "context": [ + "edit", + "view" + ], "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], "items": { - "type": "object", "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } + "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": [ + "edit", + "view" + ], + "description": "Quantity of orders made by the customer.", + "readonly": true, + "type": "integer" + }, + "password": { + "context": [ + "edit" + ], + "description": "Customer password.", + "type": "string" + }, + "role": { + "context": [ + "edit", + "view" + ], + "description": "Customer role.", + "readonly": true, + "type": "string" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" } - } + }, + "type": "object" + }, + "total_spent": { + "context": [ + "edit", + "view" + ], + "description": "Total amount spent.", + "readonly": true, + "type": "string" + }, + "username": { + "context": [ + "edit", + "view" + ], + "description": "Customer login name.", + "type": "string" } - } + }, + "title": "customer", + "type": "object" + }, + "customer_download": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "access_expires": { + "context": [ + "view" + ], + "description": "The date when download access expires, in the site's timezone.", + "readonly": true, + "type": "string" + }, + "access_expires_gmt": { + "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_name": { + "context": [ + "view" + ], + "description": "Downloadable file name.", + "readonly": true, + "type": "string" + }, + "download_url": { + "context": [ + "view" + ], + "description": "Download file URL.", + "readonly": true, + "type": "string" + }, + "downloads_remaining": { + "context": [ + "view" + ], + "description": "Number of downloads remaining.", + "readonly": true, + "type": "string" + }, + "file": { + "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" + } + }, + "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" + }, + "product_id": { + "context": [ + "view" + ], + "description": "Downloadable product ID.", + "readonly": true, + "type": "integer" + }, + "product_name": { + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + } + }, + "title": "customer_download", + "type": "object" + }, + "data_continents": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "view" + ], + "description": "2 character continent code.", + "readonly": true, + "type": "string" + }, + "countries": { + "context": [ + "view" + ], + "description": "List of countries on this continent.", + "items": { + "context": [ + "view" + ], + "properties": { + "code": { + "context": [ + "view" + ], + "description": "ISO3166 alpha-2 country code.", + "readonly": true, + "type": "string" + }, + "currency_code": { + "context": [ + "view" + ], + "description": "Default ISO4127 alpha-3 currency code for the country.", + "readonly": true, + "type": "string" + }, + "currency_pos": { + "context": [ + "view" + ], + "description": "Currency symbol position for this country.", + "readonly": true, + "type": "string" + }, + "decimal_sep": { + "context": [ + "view" + ], + "description": "Decimal separator for displayed prices for this country.", + "readonly": true, + "type": "string" + }, + "dimension_unit": { + "context": [ + "view" + ], + "description": "The unit lengths are defined in for this country.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of country.", + "readonly": true, + "type": "string" + }, + "num_decimals": { + "context": [ + "view" + ], + "description": "Number of decimal points shown in displayed prices for this country.", + "readonly": true, + "type": "integer" + }, + "states": { + "context": [ + "view" + ], + "description": "List of states in this country.", + "items": { + "context": [ + "view" + ], + "properties": { + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of state.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "thousand_sep": { + "context": [ + "view" + ], + "description": "Thousands separator for displayed prices in this country.", + "readonly": true, + "type": "string" + }, + "weight_unit": { + "context": [ + "view" + ], + "description": "The unit weights are defined in for this country.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of continent.", + "readonly": true, + "type": "string" + } + }, + "title": "data_continents", + "type": "object" + }, + "data_countries": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "view" + ], + "description": "ISO3166 alpha-2 country code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of country.", + "readonly": true, + "type": "string" + }, + "states": { + "context": [ + "view" + ], + "description": "List of states in this country.", + "items": { + "context": [ + "view" + ], + "properties": { + "code": { + "context": [ + "view" + ], + "description": "State code.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Full name of state.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "title": "data_countries", + "type": "object" + }, + "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" + } + }, + "title": "data_currencies", + "type": "object" + }, + "data_download_ips": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "user_ip_address": { + "context": [ + "view" + ], + "description": "IP address.", + "readonly": true, + "type": "string" + } + }, + "title": "data_download_ips", + "type": "object" + }, + "data_index": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "Data resource description.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "Data resource ID.", + "readonly": true, + "type": "string" + } + }, + "title": "data_index", + "type": "object" + }, + "font-collection": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "categories": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The categories for the font collection.", + "type": "array" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The description for the font collection.", + "type": "string" + }, + "font_families": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The font families for the font collection.", + "type": "array" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The name for the font collection.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the font collection.", + "readonly": true, + "type": "string" + } + }, + "title": "font-collection", + "type": "object" + }, + "leaderboard": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "headers": { + "context": [ + "view" + ], + "description": "Table headers.", + "items": { + "properties": { + "label": { + "context": [ + "edit", + "view" + ], + "description": "Table column header.", + "readonly": true, + "type": "string" + } + }, + "type": "array" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "view" + ], + "description": "Leaderboard ID.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "view" + ], + "description": "Displayed title for the leaderboard.", + "readonly": true, + "type": "string" + }, + "rows": { + "context": [ + "view" + ], + "description": "Table rows.", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Table cell display.", + "readonly": true, + "type": "string" + }, + "format": { + "context": [ + "view" + ], + "description": "Table cell format.", + "enum": [ + "currency", + "number" + ], + "readonly": true, + "required": false, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Table cell value.", + "readonly": true, + "type": "string" + } + }, + "type": "array" + }, + "readonly": true, + "type": "array" + } + }, + "title": "leaderboard", + "type": "object" + }, + "marketing_campaign": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "channel": { + "context": [ + "view" + ], + "description": "The unique identifier for the marketing channel that this campaign belongs to.", + "readonly": true, + "type": "string" + }, + "cost": { + "context": [ + "view" + ], + "description": "Cost of the marketing campaign.", + "properties": { + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "view" + ], + "description": "The unique identifier for the marketing campaign.", + "readonly": true, + "type": "string" + }, + "manage_url": { + "context": [ + "view" + ], + "description": "URL to the campaign management page.", + "readonly": true, + "type": "string" + }, + "sales": { + "context": [ + "view" + ], + "description": "Sales of the marketing campaign.", + "properties": { + "currency": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "title": { + "context": [ + "view" + ], + "description": "Title of the marketing campaign.", + "readonly": true, + "type": "string" + } + }, + "title": "marketing_campaign", + "type": "object" + }, + "marketing_campaign_type": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "channel": { + "context": [ + "view" + ], + "description": "The marketing channel that this campaign type belongs to.", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "The name of the marketing channel that this campaign type belongs to.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "The unique identifier of the marketing channel that this campaign type belongs to.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "create_url": { + "context": [ + "view" + ], + "description": "URL to the create campaign page for this campaign type.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "view" + ], + "description": "Description of the marketing campaign type.", + "readonly": true, + "type": "string" + }, + "icon_url": { + "context": [ + "view" + ], + "description": "URL to an image/icon for the campaign type.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "The unique identifier for the marketing campaign type.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "view" + ], + "description": "Name of the marketing campaign type.", + "readonly": true, + "type": "string" + } + }, + "title": "marketing_campaign_type", + "type": "object" + }, + "marketing_channel": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "Description of the marketing channel.", + "readonly": true, + "type": "string" + }, + "errors_count": { + "context": [ + "view" + ], + "description": "Number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).", + "readonly": true, + "type": "string" + }, + "icon": { + "context": [ + "view" + ], + "description": "Path to the channel icon.", + "readonly": true, + "type": "string" + }, + "is_setup_completed": { + "context": [ + "view" + ], + "description": "Whether or not the marketing channel is set up.", + "readonly": true, + "type": "boolean" + }, + "name": { + "context": [ + "view" + ], + "description": "Name of the marketing channel.", + "readonly": true, + "type": "string" + }, + "product_listings_status": { + "context": [ + "view" + ], + "description": "Status of the marketing channel's product listings.", + "readonly": true, + "type": "string" + }, + "settings_url": { + "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" + ], + "description": "Unique identifier string for the marketing channel extension, also known as the plugin slug.", + "readonly": true, + "type": "string" + } + }, + "title": "marketing_channel", + "type": "object" + }, + "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" + ], + "items": { + "context": [ + "view" + ], + "properties": { + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "tags": { + "context": [ + "view" + ], + "items": { + "context": [ + "view" + ], + "properties": { + "name": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "title": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "view" + ], + "readonly": true, + "type": "string" + } + }, + "title": "marketing_recommendation", + "type": "object" + }, + "menu-location": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The description of the menu location.", + "readonly": true, + "type": "string" + }, + "menu": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the assigned menu.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The name of the menu location.", + "readonly": true, + "type": "string" + } + }, + "title": "menu-location", + "type": "object" + }, + "nav_menu": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "auto_add": { + "context": [ + "edit", + "view" + ], + "description": "Whether to automatically add top-level pages to this menu.", + "type": "boolean" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "locations": { + "context": [ + "edit", + "view" + ], + "description": "The locations assigned to the menu.", + "items": { + "type": "string" + }, + "type": "array" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "title": "nav_menu", + "type": "object" + }, + "nav_menu_item": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the nav_menu taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the nav_menu taxonomy." + }, + { + "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" + }, + "title": "Get linked object." + } + ], + "properties": { + "attr_title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Text for the title attribute of the link element for this menu item.", + "type": "string" + }, + "classes": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Class names for the link element of this menu item.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The description of this menu item.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 0, + "description": "Unique identifier for the object.", + "minimum": 0, + "readonly": true, + "type": "integer" + }, + "invalid": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the menu item represents an object that no longer exists .", + "readonly": true, + "type": "boolean" + }, + "menu_order": { + "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": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "object": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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": [ + "edit", + "embed", + "view" + ], + "default": 0, + "description": "The ID for the parent of the object.", + "minimum": 0, + "type": "integer" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "publish", + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "target": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The target attribute of the link element for this menu item.", + "enum": [ + "", + "_blank" + ], + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the object.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "custom", + "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], + "type": "string" + }, + "type_label": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The singular label used to describe this type of menu item.", + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The URL to which this menu item points.", + "format": "uri", + "type": "string" + }, + "xfn": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The XFN relationship expressed in the link of this menu item.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "nav_menu_item", + "type": "object" + }, + "nav_menu_item-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the revision, as it exists in the database.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the object.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + } + }, + "title": "nav_menu_item-revision", + "type": "object" + }, + "navigation-fallback": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The unique identifier for the Navigation Menu.", + "readonly": true, + "type": "integer" + } + }, + "title": "navigation-fallback", + "type": "object" + }, + "note": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "actions": { + "context": [ + "edit", + "view" + ], + "description": "An array of actions, if any, for the note.", + "readonly": true, + "type": "array" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "Content of the note.", + "readonly": true, + "type": "string" + }, + "content_data": { + "context": [ + "edit", + "view" + ], + "description": "Content data for the note. JSON string. Available for re-localisation.", + "readonly": true, + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "Date the note was created.", + "readonly": true, + "type": "string" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date the note was created (GMT).", + "readonly": true, + "type": "string" + }, + "date_reminder": { + "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": [ + "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" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "The image of the note, if any.", + "readonly": true, + "type": "string" + }, + "is_deleted": { + "context": [ + "edit", + "view" + ], + "description": "Registers whether the note is deleted or not", + "readonly": true, + "type": "boolean" + }, + "is_read": { + "context": [ + "edit", + "view" + ], + "description": "Registers whether the note is read or not", + "readonly": true, + "type": "boolean" + }, + "is_snoozable": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not a user can request to be reminded about the note.", + "readonly": true, + "type": "boolean" + }, + "layout": { + "context": [ + "edit", + "view" + ], + "description": "The layout of the note (eg banner, thumbnail, plain).", + "readonly": true, + "type": "string" + }, + "locale": { + "context": [ + "edit", + "view" + ], + "description": "Locale used for the note title and content.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the note.", + "readonly": true, + "type": "string" + }, + "source": { + "context": [ + "edit", + "view" + ], + "description": "Source of the note.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "The status of the note (e.g. unactioned, actioned).", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Title of the note.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The type of the note (eg error, warning, etc).", + "readonly": true, + "type": "string" + } + }, + "title": "note", + "type": "object" + }, + "onboarding_profile": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "business_extensions": { + "context": [ + "view" + ], + "description": "Extra business extensions to install.", + "readonly": true, + "type": "array" + }, + "completed": { + "context": [ + "view" + ], + "description": "Whether or not the profile was completed.", + "readonly": true, + "type": "boolean" + }, + "industry": { + "context": [ + "view" + ], + "description": "Industry.", + "readonly": true, + "type": "array" + }, + "is_agree_marketing": { + "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" + ], + "description": "Whether or not plugins step in core profiler was skipped.", + "readonly": true, + "type": "boolean" + }, + "is_store_country_set": { + "context": [ + "view" + ], + "description": "Whether or not this store country is set via onboarding profiler.", + "readonly": true, + "type": "boolean" + }, + "number_employees": { + "context": [ + "view" + ], + "description": "Number of employees of the store.", + "enum": [ + "+250", + "<10", + "1", + "10-50", + "50-250", + "not specified" + ], + "readonly": true, + "type": "string" + }, + "other_platform": { + "context": [ + "view" + ], + "description": "Name of other platform used to sell.", + "enum": [ + "amazon", + "bigcommerce", + "ebay", + "etsy", + "magento", + "other", + "shopify", + "squarespace", + "wix" + ], + "readonly": true, + "type": "string" + }, + "other_platform_name": { + "context": [ + "view" + ], + "description": "Name of other platform used to sell (not listed).", + "readonly": true, + "type": "string" + }, + "product_count": { + "context": [ + "view" + ], + "description": "Number of products to be added.", + "enum": [ + "0", + "1-10", + "1000+", + "101-1000", + "11-100" + ], + "readonly": true, + "type": "string" + }, + "product_types": { + "context": [ + "view" + ], + "description": "Types of products sold.", + "readonly": true, + "type": "array" + }, + "revenue": { + "context": [ + "view" + ], + "description": "Current annual revenue of the store.", + "enum": [ + "10000-50000", + "2500-10000", + "50000-250000", + "more-than-250000", + "none", + "rather-not-say", + "up-to-2500" + ], + "readonly": true, + "type": "string" + }, + "selling_venues": { + "context": [ + "view" + ], + "description": "Other places the store is selling products.", + "enum": [ + "brick-mortar", + "brick-mortar-other", + "no", + "other", + "other-woocommerce" + ], + "readonly": true, + "type": "string" + }, + "setup_client": { + "context": [ + "view" + ], + "description": "Whether or not this store was setup for a client.", + "readonly": true, + "type": "boolean" + }, + "skipped": { + "context": [ + "view" + ], + "description": "Whether or not the profile was skipped.", + "readonly": true, + "type": "boolean" + }, + "store_email": { + "context": [ + "view" + ], + "description": "Store email address.", + "readonly": true, + "type": "string" + }, + "theme": { + "context": [ + "view" + ], + "description": "Selected store theme.", + "readonly": true, + "type": "string" + }, + "wccom_connected": { + "context": [ + "view" + ], + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "readonly": true, + "type": "boolean" + } + }, + "title": "onboarding_profile", + "type": "object" + }, + "onboarding_theme": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "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" + }, + "options": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "options": { + "context": [ + "view" + ], + "description": "Array of options with associated values.", + "readonly": true, + "type": "array" + } + }, + "title": "options", + "type": "object" + }, + "order": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "billing_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set billing address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "List of applied basket coupons.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "The coupon's unique code.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount applied by this coupon.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount applied by this coupon.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "errors": { + "context": [ + "edit", + "view" + ], + "description": "List of basket item errors, for example, items in the basket which are out of stock.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Error code", + "readonly": true, + "type": "string" + }, + "message": { + "context": [ + "edit", + "view" + ], + "description": "Error message", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The order ID.", + "readonly": true, + "type": "integer" + }, + "items": { + "context": [ + "edit", + "view" + ], + "description": "Line items data.", + "items": { + "properties": { + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "True if backorders are allowed past stock availability.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "catalog_visibility": { + "context": [ + "edit", + "view" + ], + "description": "Whether the product is visible in the catalogue", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Product full description in HTML format.", + "readonly": true, + "type": "string" + }, + "extensions": { + "context": [ + "edit", + "view" + ], + "properties": [], + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "The item product or variation ID.", + "readonly": true, + "type": "integer" + }, + "images": { + "context": [ + "edit", + "view" + ], + "description": "List of images.", + "items": { + "properties": { + "alt": { + "context": [ + "edit", + "view" + ], + "description": "Image alternative text.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "readonly": true, + "type": "string" + }, + "sizes": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "readonly": true, + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "readonly": true, + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "item_data": { + "context": [ + "edit", + "view" + ], + "description": "Metadata related to the item", + "items": { + "properties": { + "display": { + "context": [ + "edit", + "view" + ], + "description": "Optionally, how the metadata value should be displayed to the user.", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name of the metadata.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Value of the metadata.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the item.", + "readonly": true, + "type": "string" + }, + "low_stock_remaining": { + "context": [ + "edit", + "view" + ], + "description": "Quantity left in stock if stock is low, or null if not applicable.", + "readonly": true, + "type": [ + "integer", + "null" + ] + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "prices": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "price_range": { + "context": [ + "edit", + "view" + ], + "description": "Price range, if applicable.", + "properties": { + "max_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + }, + "min_amount": { + "context": [ + "edit", + "view" + ], + "description": "Price amount.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "raw_prices": { + "context": [ + "edit", + "view" + ], + "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", + "properties": { + "precision": { + "context": [ + "edit", + "view" + ], + "description": "Decimal precision of the returned prices.", + "readonly": true, + "type": "integer" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current product price.", + "readonly": true, + "type": "string" + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "regular_price": { + "context": [ + "edit", + "view" + ], + "description": "Regular product price.", + "readonly": true, + "type": "string" + }, + "sale_price": { + "context": [ + "edit", + "view" + ], + "description": "Sale product price, if applicable.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity of this item.", + "readonly": true, + "type": "number" + }, + "quantity_limits": { + "context": [ + "edit", + "view" + ], + "description": "How the quantity of this item should be controlled, for example, any limits in place.", + "properties": { + "editable": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "If the quantity is editable or fixed.", + "readonly": true, + "type": "boolean" + }, + "maximum": { + "context": [ + "edit", + "view" + ], + "description": "The maximum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "minimum": { + "context": [ + "edit", + "view" + ], + "description": "The minimum quantity allowed for this line item.", + "readonly": true, + "type": "integer" + }, + "multiple_of": { + "context": [ + "edit", + "view" + ], + "default": 1, + "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "short_description": { + "context": [ + "edit", + "view" + ], + "description": "Product short description in HTML format.", + "readonly": true, + "type": "string" + }, + "show_backorder_badge": { + "context": [ + "edit", + "view" + ], + "description": "True if the product is on backorder.", + "readonly": true, + "type": [ + "boolean" + ] + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Stock keeping unit, if applicable.", + "readonly": true, + "type": "string" + }, + "sold_individually": { + "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": [ + "edit", + "view" + ], + "description": "Item total amounts provided using the smallest unit of the currency.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "line_subtotal": { + "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": [ + "edit", + "view" + ], + "description": "Line subtotal tax.", + "readonly": true, + "type": "string" + }, + "line_total": { + "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": [ + "edit", + "view" + ], + "description": "Line total tax.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "The item type.", + "readonly": true, + "type": "string" + }, + "variation": { + "context": [ + "edit", + "view" + ], + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "needs_payment": { + "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": [ + "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": [ + "edit", + "view" + ], + "description": "List of required payment gateway features to process the order.", + "readonly": true, + "type": "array" + }, + "shipping_address": { + "context": [ + "edit", + "view" + ], + "description": "Current set shipping address for the customer.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "readonly": true, + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "readonly": true, + "required": true, + "type": "string" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City", + "readonly": true, + "required": true, + "type": "string" + }, + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company", + "readonly": true, + "required": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "readonly": true, + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "readonly": true, + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "readonly": true, + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "readonly": true, + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "readonly": true, + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "readonly": true, + "required": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Status of the order.", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Order totals.", + "properties": { + "currency_code": { + "context": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Subtotal of the order.", + "readonly": true, + "type": "string" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Lines of taxes applied to items and shipping.", + "items": { + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "The name of the tax.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "The amount of tax charged.", + "readonly": true, + "type": "string" + }, + "rate": { + "context": [ + "edit", + "view" + ], + "description": "The rate at which tax is applied.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total_discount": { + "context": [ + "edit", + "view" + ], + "description": "Total discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax removed due to discount from applied coupons.", + "readonly": true, + "type": "string" + }, + "total_fees": { + "context": [ + "edit", + "view" + ], + "description": "Total price of any applied fees.", + "readonly": true, + "type": "string" + }, + "total_fees_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on fees.", + "readonly": true, + "type": "string" + }, + "total_items": { + "context": [ + "edit", + "view" + ], + "description": "Total price of items in the order.", + "readonly": true, + "type": "string" + }, + "total_items_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on items in the order.", + "readonly": true, + "type": "string" + }, + "total_price": { + "context": [ + "edit", + "view" + ], + "description": "Total price the customer will pay.", + "readonly": true, + "type": "string" + }, + "total_refund": { + "context": [ + "edit", + "view" + ], + "description": "Total refund applied to the order.", + "readonly": true, + "type": "string" + }, + "total_shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total price of shipping.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax applied to the order.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "order", + "type": "object" }, "order_note": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "order_note", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "The date the order note was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the order note was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "note": { "description": "Order note content.", "type": "string", "context": ["view", "edit"] }, "customer_note": { - "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", + "context": [ + "edit", + "view" + ], "default": false, - "context": ["view", "edit"] - } - } - }, - "shop_order_refund": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shop_order_refund", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true + "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": { - "description": "The date the order refund was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "The date the order note was created, in the site's timezone.", + "readonly": true, + "type": "date-time" }, "date_created_gmt": { - "description": "The date the order refund was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "The date the order note was created, as GMT.", + "readonly": true, + "type": "date-time" }, - "amount": { "description": "Refund amount.", "type": "string", "context": ["view", "edit"] }, - "reason": { "description": "Reason for refund.", "type": "string", "context": ["view", "edit"] }, - "refunded_by": { - "description": "User ID of user who created the refund.", - "type": "integer", - "context": ["view", "edit"] + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, - "refunded_payment": { - "description": "If the payment was refunded via the API.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "note": { + "context": [ + "edit", + "view" + ], + "description": "Order note content.", + "type": "string" + } + }, + "title": "order_note", + "type": "object" + }, + "page": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + }, + "title": "The current user can change the author on this post." + } + ], + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the post.", + "type": "integer" + }, + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "comment_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "menu_order": { + "context": [ + "edit", + "view" + ], + "description": "The order of the post in relation to other posts.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "ping_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "page", + "type": "object" + }, + "page-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "page-revision", + "type": "object" + }, + "pattern-directory-item": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "block_types": { + "context": [ + "embed", + "view" + ], + "description": "The block types which can use this pattern.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "categories": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern's category slugs.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern content.", + "minLength": 1, + "type": "string" + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "A description of the pattern.", + "minLength": 1, + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern ID.", + "minimum": 1, + "type": "integer" + }, + "keywords": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern's keywords.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The pattern title, in human readable format.", + "minLength": 1, + "type": "string" + }, + "viewport_width": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The preferred width of the viewport when previewing a pattern, in pixels.", + "type": "integer" + } + }, + "title": "pattern-directory-item", + "type": "object" + }, + "patterns": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": [], + "title": "patterns", + "type": "object" + }, + "payment-gateway-suggestions": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "content": { + "context": [ + "edit", + "view" + ], + "description": "Suggestion description.", + "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": [ + "edit", + "view" + ], + "description": "Suggestion visibility.", + "readonly": true, + "type": "boolean" + }, + "plugins": { + "context": [ + "edit", + "view" + ], + "description": "Array of plugin slugs.", + "readonly": true, + "type": "array" + }, + "recommendation_priority": { + "context": [ + "edit", + "view" + ], + "description": "Priority of recommendation.", + "readonly": true, + "type": "integer" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Gateway title.", + "readonly": true, + "type": "string" + }, + "transaction_processors": { + "addtionalProperties": { + "format": "uri", + "type": "string" + }, + "context": [ + "edit", + "view" + ], + "description": "Array of transaction processors and their images.", + "readonly": true, + "type": "object" + } + }, + "title": "payment-gateway-suggestions", + "type": "object" + }, + "payment_gateway": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway description on checkout.", + "type": "string" + }, + "enabled": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway enabled status.", + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway ID.", + "readonly": true, + "type": "string" + }, + "method_description": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway method description.", + "readonly": true, + "type": "string" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway method title.", + "readonly": true, + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway sort order.", + "type": "integer" + }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Payment gateway title on checkout.", + "type": "string" + } + }, + "title": "payment_gateway", + "type": "object" + }, + "plugin": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "view" + ], + "description": "The plugin author.", + "readonly": true, + "type": "object" + }, + "author_uri": { + "context": [ + "edit", + "view" + ], + "description": "The plugin author's website address.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "description": { + "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" + } + }, + "readonly": true, + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The plugin name.", + "readonly": true, + "type": "string" + }, + "network_only": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the plugin can only be activated network wide.", + "readonly": true, + "type": "boolean" + }, + "plugin": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The plugin file.", + "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", + "readonly": true, + "type": "string" + }, + "plugin_uri": { + "context": [ + "edit", + "view" + ], + "description": "The plugin's website address.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "requires_php": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Minimum required version of PHP.", + "readonly": true, + "type": "string" + }, + "requires_wp": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Minimum required version of WordPress.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The plugin activation status.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "textdomain": { + "context": [ + "edit", + "view" + ], + "description": "The plugin's text domain.", + "readonly": true, + "type": "string" + }, + "version": { + "context": [ + "edit", + "view" + ], + "description": "The plugin version number.", + "readonly": true, + "type": "string" + } + }, + "title": "plugin", + "type": "object" + }, + "plugins": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "connectAction": { + "context": [ + "edit", + "view" + ], + "description": "Action that should be completed to connect Jetpack.", + "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" + }, + "post": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the category taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the category taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the post_tag taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the post_tag taxonomy." + } + ], + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the post.", + "type": "integer" + }, + "categories": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the category taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "comment_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "format": { + "context": [ + "edit", + "view" + ], + "description": "The format for the post.", + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], + "type": "string" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "ping_status": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "sticky": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post should be treated as sticky.", + "type": "boolean" + }, + "tags": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the post_tag taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "post", + "type": "object" + }, + "post-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "post-revision", + "type": "object" + }, + "product": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the product_cat taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the product_cat taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the product_tag taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the product_tag taxonomy." + } + ], + "properties": { + "class_list": { + "context": [ + "edit", + "view" + ], + "description": "An array of the class names for the post container element.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "featured_media": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID of the featured media for the post.", + "type": "integer" + }, + "generated_slug": { + "context": [ + "edit" + ], + "description": "Slug automatically generated from the post title.", + "readonly": true, + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "permalink_template": { + "context": [ + "edit" + ], + "description": "Permalink template for the post.", + "readonly": true, + "type": "string" + }, + "product_cat": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the product_cat taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "product_tag": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the product_tag taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "product", + "type": "object" + }, + "product-category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of objects (posts of any type) assigned to the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Term description.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Category image.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Thumbnail sizes for responsive images.", + "type": "string" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Full size image URL.", + "format": "uri", + "type": "string" + }, + "srcset": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail srcset for responsive images.", + "type": "string" + }, + "thumbnail": { + "context": [ + "edit", + "view" + ], + "description": "Thumbnail URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "Parent term ID, if applicable.", + "readonly": true, + "type": "integer" + }, + "permalink": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Category URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "review_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of reviews for products in this category.", + "readonly": true, + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "String based identifier for the term.", + "readonly": true, + "type": "string" + } + }, + "title": "product-category", + "type": "object" + }, + "product-collection-data": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "attribute_counts": { + "context": [ + "edit", + "view" + ], + "description": "Returns number of products within attribute terms.", + "items": { + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of products.", + "readonly": true, + "type": "integer" + }, + "term": { + "context": [ + "edit", + "view" + ], + "description": "Term ID", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "price_range": { + "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": [ + "edit", + "view" + ], + "description": "Currency code (in ISO format) for returned prices.", + "readonly": true, + "type": "string" + }, + "currency_decimal_separator": { + "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": [ + "edit", + "view" + ], + "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", + "readonly": true, + "type": "integer" + }, + "currency_prefix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_suffix": { + "context": [ + "edit", + "view" + ], + "description": "Price prefix for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "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": [ + "edit", + "view" + ], + "description": "Thousand separator for the currency which can be used to format returned prices.", + "readonly": true, + "type": "string" + }, + "max_price": { + "context": [ + "edit", + "view" + ], + "description": "Maximum price found in collection of products.", + "readonly": true, + "type": "string" + }, + "min_price": { + "context": [ + "edit", + "view" + ], + "description": "Minimum price found in collection of products.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": [ + "null", + "object" + ] + }, + "rating_counts": { + "context": [ + "edit", + "view" + ], + "description": "Returns number of products with each average rating.", + "items": { + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of products.", + "readonly": true, + "type": "integer" + }, + "rating": { + "context": [ + "edit", + "view" + ], + "description": "Average rating", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + }, + "stock_status_counts": { + "context": [ + "edit", + "view" + ], + "description": "Returns number of products with each stock status.", + "items": { + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of products.", + "readonly": true, + "type": "integer" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Status", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": [ + "array", + "null" + ] + } + }, + "title": "product-collection-data", + "type": "object" + }, + "product-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "product-revision", + "type": "object" + }, + "product_attribute": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "has_archives": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Enable/Disable attribute archives.", + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Attribute name.", + "type": "string" + }, + "order_by": { + "context": [ + "edit", + "view" + ], + "default": "menu_order", + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "default": "select", + "description": "Type of attribute.", + "enum": [ + "select" + ], + "type": "string" + } + }, + "title": "product_attribute", + "type": "object" + }, + "product_attribute_term": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published products for the resource.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the resource.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "menu_order": { + "context": [ + "edit", + "view" + ], + "description": "Menu order, used to custom sort the resource.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "title": "product_attribute_term", + "type": "object" + }, + "product_cat": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "context": [ + "edit", + "view" + ], + "description": "The parent term ID.", + "type": "integer" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "product_cat" + ], + "readonly": true, + "type": "string" + } + }, + "title": "product_cat", + "type": "object" + }, + "product_review": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the review was created, in the site's timezone.", + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the review was created, as GMT.", + "type": "date-time" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Reviewer email.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "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": [ + "edit", + "view" + ], + "description": "Shows if the reviewer bought the product or not.", + "readonly": true, + "type": "boolean" + } + }, + "title": "product_review", + "type": "object" + }, + "product_shipping_class": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published products for the resource.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the resource.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Shipping class name.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "title": "product_shipping_class", + "type": "object" + }, + "product_tag": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "product_tag" + ], + "readonly": true, + "type": "string" + } + }, + "title": "product_tag", + "type": "object" + }, + "product_variation": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "attributes": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "backordered": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on back-order.", + "readonly": true, + "type": "boolean" + }, + "backorders": { + "context": [ + "edit", + "view" + ], + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "type": "string" + }, + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "Shows if back-orders are allowed.", + "readonly": true, + "type": "boolean" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "Start date of sale price, in the site's timezone.", + "type": "date-time" + }, + "date_on_sale_from_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Start date of sale price, as GMT.", + "type": "date-time" + }, + "date_on_sale_to": { + "context": [ + "edit", + "view" + ], + "description": "End date of sale price, in the site's timezone.", + "type": "date-time" + }, + "date_on_sale_to_gmt": { + "context": [ + "edit", + "view" + ], + "description": "End date of sale price, as GMT.", + "type": "date-time" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Variation description.", + "type": "string" + }, + "dimensions": { + "context": [ + "edit", + "view" + ], + "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" + } + }, + "type": "object" + }, + "download_expiry": { + "context": [ + "edit", + "view" + ], + "default": -1, + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "context": [ + "edit", + "view" + ], + "default": -1, + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "downloadable": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "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": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the image was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "in_stock": { + "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": [ + "edit", + "view" + ], + "default": false, + "description": "Stock management at variation level.", + "type": "mixed" + }, + "menu_order": { + "context": [ + "edit", + "view" + ], + "description": "Menu order, used to custom sort products.", + "type": "integer" }, "meta_data": { + "context": [ + "edit", + "view" + ], "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], "items": { - "type": "object", "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } + "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" }, - "line_items": { - "description": "Line items data.", - "type": "array", - "context": ["view", "edit"], + "on_sale": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on sale.", "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { - "description": "Product name.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - }, - "product_id": { - "description": "Product ID.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Meta value.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - } - } - } + "type": "boolean" }, - "tax_lines": { - "description": "Tax lines data.", - "type": "array", - "context": ["view", "edit"], + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Variation URL.", + "format": "uri", "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "rate_code": { - "description": "Tax rate code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate_id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "Tax rate label.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "compound": { - "description": "Show if is a compound tax rate.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "tax_total": { - "description": "Tax total (not including shipping taxes).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_tax_total": { - "description": "Shipping tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } + "type": "string" }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "method_title": { - "description": "Shipping method name.", - "type": "mixed", - "context": ["view", "edit"] - }, - "method_id": { "description": "Shipping method ID.", "type": "mixed", "context": ["view", "edit"] }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": ["view", "edit"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current variation price.", + "readonly": true, + "type": "string" }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Fee name.", "type": "mixed", "context": ["view", "edit"] }, - "tax_class": { "description": "Tax class of fee.", "type": "string", "context": ["view", "edit"] }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": ["view", "edit"], - "enum": ["taxable", "none"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } + "purchasable": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation can be bought.", + "readonly": true, + "type": "boolean" }, - "api_refund": { - "description": "When true, the payment gateway API is used to generate the refund.", - "type": "boolean", - "context": ["edit"], - "default": true + "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": [ + "edit", + "view" + ], + "description": "Shipping class ID.", + "readonly": true, + "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": [ + "edit", + "view" + ], + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "type": "string" + }, + "virtual": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is virtual.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "default": true, + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "context": [ + "edit", + "view" + ], + "description": "Variation weight (kg).", + "type": "string" } - } + }, + "title": "product_variation", + "type": "object" + }, + "rendered-block": { + "$schema": "http:/json-schema.org/schema#", + "properties": { + "rendered": { + "context": [ + "edit" + ], + "description": "The rendered block.", + "required": true, + "type": "string" + } + }, + "title": "rendered-block", + "type": "object" + }, + "report": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "A human-readable description of the resource.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + } + }, + "title": "report", + "type": "object" + }, + "report_categories": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "category_id": { + "context": [ + "edit", + "view" + ], + "description": "Category ID.", + "readonly": true, + "type": "integer" + }, + "extended_info": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "Category name.", + "readonly": true, + "type": "string" + } + }, + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Amount of items sold.", + "readonly": true, + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "products_count": { + "context": [ + "edit", + "view" + ], + "description": "Amount of products.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_categories", + "type": "object" + }, + "report_coupon_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Coupon type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of coupons.", + "readonly": true, + "type": "string" + } + }, + "title": "report_coupon_total", + "type": "object" + }, + "report_coupons": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "readonly": true, + "type": "number" + }, + "coupon_id": { + "context": [ + "edit", + "view" + ], + "description": "Coupon ID.", + "readonly": true, + "type": "integer" + }, + "extended_info": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "readonly": true, + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "Coupon creation date.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Coupon creation date in GMT.", + "readonly": true, + "type": "date-time" + }, + "date_expires": { + "context": [ + "edit", + "view" + ], + "description": "Coupon expiration date.", + "readonly": true, + "type": "date-time" + }, + "date_expires_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Coupon expiration date in GMT.", + "readonly": true, + "type": "date-time" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "description": "Coupon discount type.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "readonly": true, + "type": "string" + } + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_coupons", + "type": "object" + }, + "report_coupons_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Net discount amount.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of coupons.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of discounted orders.", + "indicator": true, + "readonly": true, + "title": "Discounted orders", + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_coupons_stats", + "type": "object" + }, + "report_customer_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Customer type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of customers.", + "readonly": true, + "type": "string" + } + }, + "title": "report_customer_total", + "type": "object" + }, + "report_customers": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "avg_order_value": { + "context": [ + "edit", + "view" + ], + "description": "Average order value", + "readonly": true, + "type": "number" + }, + "city": { + "context": [ + "edit", + "view" + ], + "description": "City.", + "readonly": true, + "type": "string" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region.", + "readonly": true, + "type": "string" + }, + "date_last_active": { + "context": [ + "edit", + "view" + ], + "description": "Date last active.", + "readonly": true, + "type": "date-time" + }, + "date_last_active_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date last active GMT.", + "readonly": true, + "type": "date-time" + }, + "date_registered": { + "context": [ + "edit", + "view" + ], + "description": "Date registered.", + "readonly": true, + "type": "date-time" + }, + "date_registered_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date registered GMT.", + "readonly": true, + "type": "date-time" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Name.", + "readonly": true, + "type": "string" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Order count.", + "readonly": true, + "type": "integer" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "readonly": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "Region.", + "readonly": true, + "type": "string" + }, + "total_spend": { + "context": [ + "edit", + "view" + ], + "description": "Total spend.", + "readonly": true, + "type": "number" + }, + "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" + }, + "report_customers_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "avg_avg_order_value": { + "context": [ + "edit", + "view" + ], + "description": "Average AOV per customer.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "avg_orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Average number of orders.", + "readonly": true, + "type": "integer" + }, + "avg_total_spend": { + "context": [ + "edit", + "view" + ], + "description": "Average total spend per customer.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "customers_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of customers.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_customers_stats", + "type": "object" + }, + "report_downloads": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date": { + "context": [ + "edit", + "view" + ], + "description": "The date of the download, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date of the download, as GMT.", + "readonly": true, + "type": "date-time" + }, + "download_id": { + "context": [ + "edit", + "view" + ], + "description": "Download ID.", + "readonly": true, + "type": "string" + }, + "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": [ + "edit", + "view" + ], + "description": "IP address for the downloader.", + "readonly": true, + "type": "string" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order Number.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, + "user_id": { + "context": [ + "edit", + "view" + ], + "description": "User ID for the downloader.", + "readonly": true, + "type": "integer" + }, + "username": { + "context": [ + "edit", + "view" + ], + "description": "User name of the downloader.", + "readonly": true, + "type": "string" + } + }, + "title": "report_downloads", + "type": "object" + }, + "report_export": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "export_id": { + "context": [ + "edit", + "view" + ], + "description": "Export ID.", + "readonly": true, + "type": "string" + }, + "message": { + "context": [ + "edit", + "view" + ], + "description": "Export status message.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Export status.", + "readonly": true, + "type": "string" + } + }, + "title": "report_export", + "type": "object" + }, + "report_export_status": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "download_url": { + "context": [ + "edit", + "view" + ], + "description": "Export download URL.", + "readonly": true, + "type": "string" + }, + "percent_complete": { + "context": [ + "edit", + "view" + ], + "description": "Percentage complete.", + "readonly": true, + "type": "int" + } + }, + "title": "report_export_status", + "type": "object" + }, + "report_import": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "message": { + "context": [ + "edit", + "view" + ], + "description": "Regenerate data message.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Regeneration status.", + "readonly": true, + "type": "string" + } + }, + "title": "report_import", + "type": "object" + }, + "report_order_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Order status name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of orders.", + "readonly": true, + "type": "string" + } + }, + "title": "report_order_total", + "type": "object" + }, + "report_orders": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "customer_id": { + "context": [ + "edit", + "view" + ], + "description": "Customer ID.", + "readonly": true, + "type": "integer" + }, + "customer_type": { + "context": [ + "edit", + "view" + ], + "description": "Returning or new customer.", + "readonly": true, + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "Date the order was created, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "Date the order was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "extended_info": { + "attribution": { + "context": [ + "edit", + "view" + ], + "description": "Order attribution information.", + "readonly": true, + "type": "object" + }, + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "List of order coupons.", + "readonly": true, + "type": "array" + }, + "customer": { + "context": [ + "edit", + "view" + ], + "description": "Order customer information.", + "readonly": true, + "type": "object" + }, + "products": { + "context": [ + "edit", + "view" + ], + "description": "List of order product IDs, names, quantities.", + "readonly": true, + "type": "array" + } + }, + "net_total": { + "context": [ + "edit", + "view" + ], + "description": "Net total revenue.", + "readonly": true, + "type": "float" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of items sold.", + "readonly": true, + "type": "integer" + }, + "order_id": { + "context": [ + "edit", + "view" + ], + "description": "Order ID.", + "readonly": true, + "type": "integer" + }, + "order_number": { + "context": [ + "edit", + "view" + ], + "description": "Order Number.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "Order status.", + "readonly": true, + "type": "string" + }, + "total_formatted": { + "context": [ + "edit", + "view" + ], + "description": "Net total revenue (formatted).", + "readonly": true, + "type": "string" + } + }, + "title": "report_orders", + "type": "object" + }, + "report_orders_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "context": [ + "edit", + "view" + ], + "description": "The date the report end, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_end_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_start": { + "context": [ + "edit", + "view" + ], + "description": "The date the report start, in the site's time zone.", + "readonly": true, + "type": "date-time" + }, + "date_start_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "readonly": true, + "type": "date-time" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "download_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of downloads.", + "indicator": true, + "readonly": true, + "title": "Downloads", + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "download_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of downloads.", + "indicator": true, + "readonly": true, + "title": "Downloads", + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_orders_stats", + "type": "object" + }, + "report_performance_indicator": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "chart": { + "context": [ + "edit", + "view" + ], + "description": "The specific chart this stat referrers to.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable label for the stat.", + "readonly": true, + "type": "string" + }, + "stat": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "enum": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "readonly": true, + "type": "string" + } + }, + "title": "report_performance_indicator", + "type": "object" + }, + "report_product_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Product type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of products.", + "readonly": true, + "type": "string" + } + }, + "title": "report_product_total", + "type": "object" + }, + "report_products": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "extended_info": { + "category_ids": { + "context": [ + "edit", + "view" + ], + "description": "Product category IDs.", + "readonly": true, + "type": "array" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Product image.", + "readonly": true, + "type": "string" + }, + "low_stock_amount": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory threshold for low stock.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product link.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory quantity.", + "readonly": true, + "type": "integer" + }, + "stock_status": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory status.", + "readonly": true, + "type": "string" + }, + "variations": { + "context": [ + "edit", + "view" + ], + "description": "Product variations IDs.", + "readonly": true, + "type": "array" + } + }, + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of items sold.", + "readonly": true, + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Total Net sales of all items sold.", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders product appeared in.", + "readonly": true, + "type": "integer" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_products", + "type": "object" + }, + "report_products_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of product items sold.", + "indicator": true, + "readonly": true, + "title": "Products sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_products_stats", + "type": "object" + }, + "report_revenue_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "products": { + "context": [ + "edit", + "view" + ], + "description": "Products sold.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "coupons": { + "context": [ + "edit", + "view" + ], + "description": "Amount discounted by coupons.", + "readonly": true, + "type": "number" + }, + "coupons_count": { + "context": [ + "edit", + "view" + ], + "description": "Unique coupons count.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "gross_sales": { + "context": [ + "edit", + "view" + ], + "description": "Gross sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "num_items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Items sold.", + "readonly": true, + "type": "integer" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "Total of returns.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Returns", + "type": "number" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping": { + "context": [ + "edit", + "view" + ], + "description": "Total of shipping.", + "format": "currency", + "indicator": true, + "readonly": true, + "title": "Shipping", + "type": "number" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Total of taxes.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "total_sales": { + "context": [ + "edit", + "view" + ], + "description": "Total sales.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_revenue_stats", + "type": "object" + }, + "report_review_total": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "view" + ], + "description": "Review type name.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "view" + ], + "description": "An alphanumeric identifier for the resource.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "view" + ], + "description": "Amount of reviews.", + "readonly": true, + "type": "string" + } + }, + "title": "report_review_total", + "type": "object" + }, + "report_stock": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "manage_stock": { + "context": [ + "edit", + "view" + ], + "description": "Manage stock.", + "readonly": true, + "type": "boolean" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "parent_id": { + "context": [ + "edit", + "view" + ], + "description": "Product parent ID.", + "readonly": true, + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier.", + "readonly": true, + "type": "string" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Stock quantity.", + "readonly": true, + "type": "integer" + }, + "stock_status": { + "context": [ + "edit", + "view" + ], + "description": "Stock status.", + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "readonly": true, + "type": "string" + } + }, + "title": "report_stock", + "type": "object" + }, + "report_taxes": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country/Region.", + "readonly": true, + "type": "string" + }, + "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": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "priority": { + "context": [ + "edit", + "view" + ], + "description": "Priority.", + "readonly": true, + "type": "integer" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "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": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "readonly": true, + "type": "number" + } + }, + "title": "report_taxes", + "type": "object" + }, + "report_taxes_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "order_tax": { + "context": [ + "edit", + "view" + ], + "description": "Order tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + }, + "tax_codes": { + "context": [ + "edit", + "view" + ], + "description": "Amount of tax codes.", + "readonly": true, + "type": "integer" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total tax.", + "format": "currency", + "indicator": true, + "readonly": true, + "type": "number" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_taxes_stats", + "type": "object" + }, + "report_variations_stats": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "intervals": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by intervals.", + "items": { + "properties": { + "date_end": { + "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": [ + "edit", + "view" + ], + "description": "The date the report end, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "date_start": { + "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": [ + "edit", + "view" + ], + "description": "The date the report start, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "interval": { + "context": [ + "edit", + "view" + ], + "description": "Type of interval.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "totals": { + "context": [ + "edit", + "view" + ], + "description": "Totals data.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + }, + "segments": { + "context": [ + "edit", + "view" + ], + "description": "Reports data grouped by segment condition.", + "items": { + "properties": { + "segment_id": { + "context": [ + "edit", + "view" + ], + "description": "Segment identificator.", + "readonly": true, + "type": "integer" + }, + "segment_label": { + "context": [ + "edit", + "view" + ], + "description": "Human readable segment label, either product or variation name.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "readonly": true, + "type": "string" + }, + "subtotals": { + "context": [ + "edit", + "view" + ], + "description": "Interval subtotals.", + "properties": { + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of variation items sold.", + "indicator": true, + "readonly": true, + "title": "Variations Sold", + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Net sales.", + "format": "currency", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "report_variations_stats", + "type": "object" + }, + "report_varitations": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "extended_info": { + "attributes": { + "context": [ + "edit", + "view" + ], + "description": "Product attributes.", + "readonly": true, + "type": "array" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Product image.", + "readonly": true, + "type": "string" + }, + "low_stock_amount": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory threshold for low stock.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Product link.", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "stock_quantity": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory quantity.", + "readonly": true, + "type": "integer" + }, + "stock_status": { + "context": [ + "edit", + "view" + ], + "description": "Product inventory status.", + "readonly": true, + "type": "string" + } + }, + "items_sold": { + "context": [ + "edit", + "view" + ], + "description": "Number of items sold.", + "readonly": true, + "type": "integer" + }, + "net_revenue": { + "context": [ + "edit", + "view" + ], + "description": "Total Net sales of all items sold.", + "readonly": true, + "type": "number" + }, + "orders_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of orders product appeared in.", + "readonly": true, + "type": "integer" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "report_varitations", + "type": "object" + }, + "sales_report": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "average_sales": { + "context": [ + "view" + ], + "description": "Average net daily sales.", + "readonly": true, + "type": "string" + }, + "net_sales": { + "context": [ + "view" + ], + "description": "Net sales in the period.", + "readonly": true, + "type": "string" + }, + "total_discount": { + "context": [ + "view" + ], + "description": "Total of coupons used.", + "readonly": true, + "type": "integer" + }, + "total_items": { + "context": [ + "view" + ], + "description": "Total of items purchased.", + "readonly": true, + "type": "integer" + }, + "total_orders": { + "context": [ + "view" + ], + "description": "Total of orders placed.", + "readonly": true, + "type": "integer" + }, + "total_refunds": { + "context": [ + "view" + ], + "description": "Total of refunded orders.", + "readonly": true, + "type": "integer" + }, + "total_sales": { + "context": [ + "view" + ], + "description": "Gross sales in the period.", + "readonly": true, + "type": "string" + }, + "total_shipping": { + "context": [ + "view" + ], + "description": "Total charged for shipping.", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "view" + ], + "description": "Total charged for taxes.", + "readonly": true, + "type": "string" + }, + "totals": { + "context": [ + "view" + ], + "description": "Totals.", + "items": { + "type": "array" + }, + "readonly": true, + "type": "array" + }, + "totals_grouped_by": { + "context": [ + "view" + ], + "description": "Group type.", + "readonly": true, + "type": "string" + } + }, + "title": "sales_report", + "type": "object" + }, + "search-result": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "embed", + "view" + ], + "description": "Unique identifier for the object.", + "readonly": true, + "type": [ + "integer", + "string" + ] + }, + "subtype": { + "context": [ + "embed", + "view" + ], + "description": "Object subtype.", + "enum": [ + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], + "readonly": true, + "type": "string" + }, + "title": { + "context": [ + "embed", + "view" + ], + "description": "The title for the object.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "embed", + "view" + ], + "description": "Object type.", + "enum": [ + "post", + "post-format", + "term" + ], + "readonly": true, + "type": "string" + }, + "url": { + "context": [ + "embed", + "view" + ], + "description": "URL to the object.", + "format": "uri", + "readonly": true, + "type": "string" + } + }, + "title": "search-result", + "type": "object" + }, + "setting": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "mixed" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "options": { + "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": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea", + "thumbnail_cropping" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "mixed" + } + }, + "title": "setting", + "type": "object" + }, + "setting_group": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "context": [ + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "A unique identifier that can be used to link settings together.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "parent_id": { + "context": [ + "view" + ], + "description": "ID of parent grouping.", + "readonly": true, + "type": "string" + }, + "sub_groups": { + "context": [ + "view" + ], + "description": "IDs for settings sub groups.", + "readonly": true, + "type": "string" + } + }, + "title": "setting_group", + "type": "object" + }, + "settings": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_format": { + "default": null, + "description": "A date format for all date strings.", + "title": "", + "type": "string" + }, + "default_category": { + "default": null, + "description": "Default post category.", + "title": "", + "type": "integer" + }, + "default_comment_status": { + "default": null, + "description": "Allow people to submit comments on new posts.", + "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": [ + "closed", + "open" + ], + "title": "", + "type": "string" + }, + "default_post_format": { + "default": null, + "description": "Default post format.", + "title": "", + "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.", + "format": "email", + "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", + "title": "", + "type": "integer" + }, + "page_on_front": { + "default": null, + "description": "The ID of the page that should be displayed on the front page", + "title": "Page on front", + "type": "integer" + }, + "pickup_location_settings": { + "additionalProperties": false, + "default": [], + "description": "WooCommerce Local Pickup Method Settings", + "properties": { + "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": [ + "no", + "yes" + ], + "type": "string" + }, + "tax_status": { + "description": "If a cost is defined, this controls if taxes are applied to that cost.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "title": { + "description": "This controls the title which the user sees during checkout.", + "type": "string" + } + }, + "title": "", + "type": "object" + }, + "pickup_locations": { + "default": [], + "description": "WooCommerce Local Pickup Locations", + "items": { + "additionalProperties": false, + "properties": { + "address": { + "additionalProperties": false, + "properties": { + "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" + } + }, + "type": "object" + }, + "title": "", + "type": "array" + }, + "posts_per_page": { + "default": 10, + "description": "Blog pages show at most.", + "title": "Maximum posts per page", + "type": "integer" + }, + "show_on_front": { + "default": null, + "description": "What to show on the front page", + "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" + }, + "start_of_week": { + "default": null, + "description": "A day number of the week that the week should start on.", + "title": "", + "type": "integer" + }, + "time_format": { + "default": null, + "description": "A time format for all time strings.", + "title": "", + "type": "string" + }, + "timezone": { + "default": null, + "description": "A city in the same timezone as you.", + "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.", + "title": "", + "type": "boolean" + } + }, + "title": "settings", + "type": "object" + }, + "shipping-partner-suggestions": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "items": [ + { + "anyOf": [ + { + "required": "layout_row" + }, + { + "required": "layout_column" + } + ], + "properties": { + "available_layouts": { + "context": [ + "edit", + "view" + ], + "description": "Available layouts -- single, dual, or both", + "items": { + "enum": [ + "column", + "row" + ], + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Description", + "readonly": true, + "type": "string" + }, + "is_visible": { + "context": [ + "edit", + "view" + ], + "description": "Suggestion visibility.", + "readonly": true, + "type": "boolean" + }, + "layout_column": { + "properties": { + "features": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "image": { + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "layout_row": { + "properties": { + "features": { + "items": { + "properties": { + "description": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "image": { + "description": "", + "type": "string" + } + }, + "type": "object" + }, + "learn_more_link": { + "context": [ + "edit", + "view" + ], + "description": "Learn more link .", + "readonly": true, + "type": "string" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Plugin name.", + "readonly": true, + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Plugin slug used in https:/wordpress.org/plugins/{slug}.", + "readonly": true, + "type": "string" + } + }, + "required": [ + "available_layouts", + "is_visible", + "name" + ], + "type": "object" + } + ], + "title": "shipping-partner-suggestions", + "type": "array" + }, + "shipping_method": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "description": { + "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" + } + }, + "title": "shipping_method", + "type": "object" + }, + "shipping_zone": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "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" + }, + "shipping_zone_location": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "default": "country", + "description": "Shipping zone location type.", + "enum": [ + "continent", + "country", + "postcode", + "state" + ], + "type": "string" + } + }, + "title": "shipping_zone_location", + "type": "object" + }, + "shipping_zone_method": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "enabled": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method enabled status.", + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method instance ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method instance ID.", + "readonly": true, + "type": "integer" + }, + "method_description": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method description.", + "readonly": true, + "type": "string" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "readonly": true, + "type": "string" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method title.", + "readonly": true, + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method sort order.", + "type": "integer" + }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method customer facing title.", + "readonly": true, + "type": "string" + } + }, + "title": "shipping_zone_method", + "type": "object" + }, + "shop_coupon": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "string" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_expires": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon expires, in the site's timezone.", + "type": "date-time" + }, + "date_expires_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the coupon expires, as GMT.", + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the coupon was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "context": [ + "edit", + "view" + ], + "default": "fixed_cart", + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "type": "string" + }, + "email_restrictions": { + "context": [ + "edit", + "view" + ], + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "type": "array" + }, + "exclude_sale_items": { + "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": [ + "edit", + "view" + ], + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "excluded_product_ids": { + "context": [ + "edit", + "view" + ], + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "free_shipping": { + "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": [ + "edit", + "view" + ], + "description": "Unique identifier for the object.", + "readonly": true, + "type": "integer" + }, + "individual_use": { + "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": [ + "edit", + "view" + ], + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "context": [ + "edit", + "view" + ], + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "minimum_amount": { + "context": [ + "edit", + "view" + ], + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "context": [ + "edit", + "view" + ], + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "product_ids": { + "context": [ + "edit", + "view" + ], + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_count": { + "context": [ + "edit", + "view" + ], + "description": "Number of times the coupon has been used already.", + "readonly": true, + "type": "integer" + }, + "usage_limit": { + "context": [ + "edit", + "view" + ], + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "context": [ + "edit", + "view" + ], + "description": "How many times the coupon can be used per customer.", + "type": "integer" + }, + "used_by": { + "context": [ + "edit", + "view" + ], + "description": "List of user IDs (or guest email addresses) that have used the coupon.", + "items": { + "type": "integer" + }, + "readonly": true, + "type": "array" + } + }, + "title": "shop_coupon", + "type": "object" }, "shop_order": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shop_order", - "type": "object", "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "parent_id": { "description": "Parent order ID.", "type": "integer", "context": ["view", "edit"] }, - "number": { "description": "Order number.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "order_key": { "description": "Order key.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "created_via": { - "description": "Shows where the order was created.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "version": { - "description": "Version of WooCommerce which last updated the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Order status.", - "type": "string", - "default": "pending", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "billing": { + "context": [ + "edit", + "view" ], - "context": ["view", "edit"] + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "type": "object" + }, + "cart_hash": { + "context": [ + "edit", + "view" + ], + "description": "MD5 hash of basket items to ensure orders are not modified.", + "readonly": true, + "type": "string" + }, + "cart_tax": { + "context": [ + "edit", + "view" + ], + "description": "Sum of line item taxes only.", + "readonly": true, + "type": "string" + }, + "coupon_lines": { + "context": [ + "edit", + "view" + ], + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": "mixed" + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "created_via": { + "context": [ + "edit", + "view" + ], + "description": "Shows where the order was created.", + "readonly": true, + "type": "string" }, "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", + "context": [ + "edit", + "view" + ], "default": "EUR", + "description": "Currency the order was created with, in ISO format.", "enum": [ "AED", "AFN", @@ -921,8 +18618,8 @@ "BTC", "BTN", "BWP", - "BYR", "BYN", + "BYR", "BZD", "CAD", "CDF", @@ -1061,12589 +18758,3113 @@ "ZAR", "ZMW" ], - "context": ["view", "edit"] - }, - "date_created": { - "description": "The date the order was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the order was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the order was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the order was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "discount_total": { - "description": "Total discount amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_tax": { - "description": "Total discount tax amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_total": { - "description": "Total shipping amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_tax": { - "description": "Total shipping tax amount for the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "cart_tax": { - "description": "Sum of line item taxes only.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { "description": "Grand total.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "total_tax": { - "description": "Sum of all taxes.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "prices_include_tax": { - "description": "True the prices included tax during checkout.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "default": 0, - "context": ["view", "edit"] - }, - "customer_ip_address": { - "description": "Customer's IP address.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_user_agent": { - "description": "User agent of the customer.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "billing": { - "description": "Billing address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"] - }, - "email": { - "description": "Email address.", - "type": ["string", "null"], - "format": "email", - "context": ["view", "edit"] - }, - "phone": { "description": "Phone number.", "type": "string", "context": ["view", "edit"] } - } - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { "description": "First name.", "type": "string", "context": ["view", "edit"] }, - "last_name": { "description": "Last name.", "type": "string", "context": ["view", "edit"] }, - "company": { "description": "Company name.", "type": "string", "context": ["view", "edit"] }, - "address_1": { "description": "Address line 1", "type": "string", "context": ["view", "edit"] }, - "address_2": { "description": "Address line 2", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": ["view", "edit"] - }, - "postcode": { "description": "Postal code.", "type": "string", "context": ["view", "edit"] }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"] - } - } - }, - "payment_method": { "description": "Payment method ID.", "type": "string", "context": ["view", "edit"] }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "context": ["view", "edit"] - }, - "transaction_id": { "description": "Unique transaction ID.", "type": "string", "context": ["view", "edit"] }, - "date_paid": { - "description": "The date the order was paid, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_paid_gmt": { - "description": "The date the order was paid, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_completed": { - "description": "The date the order was completed, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_completed_gmt": { - "description": "The date the order was completed, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "cart_hash": { - "description": "MD5 hash of basket items to ensure orders are not modified.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Product name.", "type": "mixed", "context": ["view", "edit"] }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": ["view", "edit"] - }, - "product_id": { "description": "Product ID.", "type": "mixed", "context": ["view", "edit"] }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": ["view", "edit"] - }, - "quantity": { "description": "Quantity ordered.", "type": "integer", "context": ["view", "edit"] }, - "tax_class": { "description": "Tax class of product.", "type": "string", "context": ["view", "edit"] }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Tax rate ID", "type": "integer", "context": ["view", "edit"] }, - "total": { "description": "Tax total.", "type": "string", "context": ["view", "edit"] }, - "subtotal": { "description": "Tax subtotal.", "type": "string", "context": ["view", "edit"] } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": ["view", "edit"] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": ["view", "edit"] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - } - } - } - } - } - }, - "tax_lines": { - "description": "Tax lines data.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "rate_code": { - "description": "Tax rate code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate_id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "Tax rate label.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "compound": { - "description": "Show if is a compound tax rate.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "tax_total": { - "description": "Tax total (not including shipping taxes).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "shipping_tax_total": { - "description": "Shipping tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "method_title": { - "description": "Shipping method name.", - "type": "mixed", - "context": ["view", "edit"] - }, - "method_id": { "description": "Shipping method ID.", "type": "mixed", "context": ["view", "edit"] }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": ["view", "edit"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Fee name.", "type": "mixed", "context": ["view", "edit"] }, - "tax_class": { "description": "Tax class of fee.", "type": "string", "context": ["view", "edit"] }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": ["view", "edit"], - "enum": ["taxable", "none"] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": ["view", "edit"] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Item ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "code": { "description": "Coupon code.", "type": "mixed", "context": ["view", "edit"] }, - "discount": { "description": "Discount total.", "type": "string", "context": ["view", "edit"] }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": ["view"], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - } - }, - "refunds": { - "description": "List of refunds.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Refund ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "reason": { - "description": "Refund reason.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Refund total.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "payment_url": { - "description": "Order payment URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "default": false, - "context": ["edit"] - }, - "is_editable": { - "description": "Whether an order can be edited.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_payment": { - "description": "Whether an order needs payment, based on status and order total.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_processing": { - "description": "Whether an order needs processing before it can be completed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_attribute_term": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_attribute_term", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Term name.", "type": "string", "context": ["view", "edit"] }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "context": ["view", "edit"] - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "context": ["view", "edit"] - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "context": ["view", "edit"] - }, - "count": { - "description": "Number of published products for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_attribute": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_attribute", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Attribute name.", "type": "string", "context": ["view", "edit"] }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "context": ["view", "edit"] - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "default": "select", - "enum": ["select"], - "context": ["view", "edit"] - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "default": "menu_order", - "enum": ["menu_order", "name", "name_num", "id"], - "context": ["view", "edit"] - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - } - } - }, - "product_cat": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_cat", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["product_cat"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "parent": { "description": "The parent term ID.", "type": "integer", "context": ["view", "edit"] }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "product_review": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_review", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "review": { "description": "The content of the review.", "type": "string", "context": ["view", "edit"] }, - "date_created": { - "description": "The date the review was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_created_gmt": { - "description": "The date the review was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "rating": { "description": "Review rating (0 to 5).", "type": "integer", "context": ["view", "edit"] }, - "name": { "description": "Reviewer name.", "type": "string", "context": ["view", "edit"] }, - "email": { "description": "Reviewer email.", "type": "string", "context": ["view", "edit"] }, - "verified": { - "description": "Shows if the reviewer bought the product or not.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_shipping_class": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_shipping_class", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Shipping class name.", "type": "string", "context": ["view", "edit"] }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "context": ["view", "edit"] - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "context": ["view", "edit"] - }, - "count": { - "description": "Number of published products for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product_tag": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_tag", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["product_tag"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "product": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "product_cat": { - "description": "The terms assigned to the object in the product_cat taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "product_tag": { - "description": "The terms assigned to the object in the product_tag taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-product_cat", - "title": "The current user can assign terms in the product_cat taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_cat": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-product_cat", - "title": "The current user can create terms in the product_cat taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_cat": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-assign-product_tag", - "title": "The current user can assign terms in the product_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_tag": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-product_tag", - "title": "The current user can create terms in the product_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/product/{id}", - "targetSchema": { - "type": "object", - "properties": { "product_tag": { "type": "array", "items": { "type": "integer" } } } - } - } - ] - }, - "product_variation": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product_variation", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "The date the variation was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the variation was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "description": { "description": "Variation description.", "type": "string", "context": ["view", "edit"] }, - "permalink": { - "description": "Variation URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { "description": "Unique identifier.", "type": "string", "context": ["view", "edit"] }, - "price": { - "description": "Current variation price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { "description": "Variation regular price.", "type": "string", "context": ["view", "edit"] }, - "sale_price": { "description": "Variation sale price.", "type": "string", "context": ["view", "edit"] }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"] - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": "date-time", - "context": ["view", "edit"] - }, - "on_sale": { - "description": "Shows if the variation is on sale.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "visible": { - "description": "Define if the variation is visible on the product's page.", - "type": "boolean", - "default": true, - "context": ["view", "edit"] - }, - "purchasable": { - "description": "Shows if the variation can be bought.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "File ID.", "type": "string", "context": ["view", "edit"] }, - "name": { "description": "File name.", "type": "string", "context": ["view", "edit"] }, - "file": { "description": "File URL.", "type": "string", "context": ["view", "edit"] } - } - } - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "default": -1, - "context": ["view", "edit"] - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "default": -1, - "context": ["view", "edit"] - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "default": "taxable", - "enum": ["taxable", "shipping", "none"], - "context": ["view", "edit"] - }, - "tax_class": { "description": "Tax class.", "type": "string", "context": ["view", "edit"] }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "mixed", - "default": false, - "context": ["view", "edit"] - }, - "stock_quantity": { "description": "Stock quantity.", "type": "integer", "context": ["view", "edit"] }, - "in_stock": { - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "default": true, - "context": ["view", "edit"] - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "default": "no", - "enum": ["no", "notify", "yes"], - "context": ["view", "edit"] - }, - "backorders_allowed": { - "description": "Shows if back-orders are allowed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "backordered": { - "description": "Shows if the variation is on back-order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "weight": { "description": "Variation weight (kg).", "type": "string", "context": ["view", "edit"] }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "length": { "description": "Variation length (cm).", "type": "string", "context": ["view", "edit"] }, - "width": { "description": "Variation width (cm).", "type": "string", "context": ["view", "edit"] }, - "height": { "description": "Variation height (cm).", "type": "string", "context": ["view", "edit"] } - } - }, - "shipping_class": { "description": "Shipping class slug.", "type": "string", "context": ["view", "edit"] }, - "shipping_class_id": { - "description": "Shipping class ID.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "Variation image data.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "src": { "description": "Image URL.", "type": "string", "format": "uri", "context": ["view", "edit"] }, - "name": { "description": "Image name.", "type": "string", "context": ["view", "edit"] }, - "alt": { "description": "Image alternative text.", "type": "string", "context": ["view", "edit"] }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": ["view", "edit"] - } - } - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Attribute ID.", "type": "integer", "context": ["view", "edit"] }, - "name": { "description": "Attribute name.", "type": "string", "context": ["view", "edit"] }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": ["view", "edit"] - } - } - } - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "context": ["view", "edit"] - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { "description": "Meta ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "key": { "description": "Meta key.", "type": "string", "context": ["view", "edit"] }, - "value": { "description": "Meta value.", "type": "mixed", "context": ["view", "edit"] } - } - } - } - } - }, - "sales_report": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "sales_report", - "type": "object", - "properties": { - "total_sales": { - "description": "Gross sales in the period.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "net_sales": { - "description": "Net sales in the period.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "average_sales": { - "description": "Average net daily sales.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "total_orders": { - "description": "Total of orders placed.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "total_items": { - "description": "Total of items purchased.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "total_tax": { - "description": "Total charged for taxes.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "total_shipping": { - "description": "Total charged for shipping.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "total_refunds": { - "description": "Total of refunded orders.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "total_discount": { - "description": "Total of coupons used.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "totals_grouped_by": { - "description": "Group type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "totals": { - "description": "Totals.", - "type": "array", - "items": { "type": "array" }, - "context": ["view"], - "readonly": true - } - } - }, - "top_sellers_report": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "top_sellers_report", - "type": "object", - "properties": { - "name": { "description": "Product name.", "type": "string", "context": ["view"], "readonly": true }, - "product_id": { "description": "Product ID.", "type": "integer", "context": ["view"], "readonly": true }, - "quantity": { - "description": "Total number of purchases.", - "type": "integer", - "context": ["view"], - "readonly": true - } - } - }, - "report_order_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_order_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Order status name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of orders.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_product_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_product_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Product type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of products.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_customer_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_customer_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Customer type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of customers.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_coupon_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_coupon_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Coupon type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of coupons.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report_review_total": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_review_total", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { "description": "Review type name.", "type": "string", "context": ["view"], "readonly": true }, - "total": { "description": "Amount of reviews.", "type": "string", "context": ["view"], "readonly": true } - } - }, - "report": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report", - "type": "object", - "properties": { - "slug": { - "description": "An alphanumeric identifier for the resource.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "A human-readable description of the resource.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "setting_group": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "setting_group", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier that can be used to link settings together.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "parent_id": { - "description": "ID of parent grouping.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "sub_groups": { - "description": "IDs for settings sub groups.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "setting": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "setting", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { "description": "Setting value.", "type": "mixed", "context": ["view", "edit"] }, - "default": { - "description": "Default value for the setting.", - "type": "mixed", - "context": ["view", "edit"], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": ["view", "edit"], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox", - "thumbnail_cropping" - ], - "readonly": true - }, - "options": { - "description": "Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.", - "type": "object", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "shipping_zone": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_zone", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Shipping zone name.", "type": "string", "context": ["view", "edit"] }, - "order": { "description": "Shipping zone order.", "type": "integer", "context": ["view", "edit"] } - } - }, - "shipping_zone_location": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_zone_location", - "type": "object", - "properties": { - "code": { "description": "Shipping zone location code.", "type": "string", "context": ["view", "edit"] }, - "type": { - "description": "Shipping zone location type.", - "type": "string", - "default": "country", - "enum": ["postcode", "state", "country", "continent"], - "context": ["view", "edit"] - } - } - }, - "shipping_zone_method": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_zone_method", - "type": "object", - "properties": { - "id": { - "description": "Shipping method instance ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "instance_id": { - "description": "Shipping method instance ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "title": { - "description": "Shipping method customer facing title.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order": { "description": "Shipping method sort order.", "type": "integer", "context": ["view", "edit"] }, - "enabled": { - "description": "Shipping method enabled status.", - "type": "boolean", - "context": ["view", "edit"] - }, - "method_id": { - "description": "Shipping method ID.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_title": { - "description": "Shipping method title.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_description": { - "description": "Shipping method description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "settings": { - "description": "Shipping method settings.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": ["view", "edit"], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { "description": "Setting value.", "type": "string", "context": ["view", "edit"] }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "tax_class": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "tax_class", - "type": "object", - "properties": { - "slug": { - "description": "Unique identifier for the resource.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Tax class name.", "type": "string", "context": ["view", "edit"], "required": true } - } - }, - "tax": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "tax", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "country": { "description": "Country ISO 3166 code.", "type": "string", "context": ["view", "edit"] }, - "state": { "description": "State code.", "type": "string", "context": ["view", "edit"] }, - "postcode": { "description": "Postcode / ZIP.", "type": "string", "context": ["view", "edit"] }, - "city": { "description": "City name.", "type": "string", "context": ["view", "edit"] }, - "rate": { "description": "Tax rate.", "type": "string", "context": ["view", "edit"] }, - "name": { "description": "Tax rate name.", "type": "string", "context": ["view", "edit"] }, - "priority": { "description": "Tax priority.", "type": "integer", "default": 1, "context": ["view", "edit"] }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "default": false, - "context": ["view", "edit"] - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "default": true, - "context": ["view", "edit"] - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "context": ["view", "edit"] - }, - "class": { - "description": "Tax class.", - "type": "string", - "default": "standard", - "enum": ["standard", "reduced-rate", "zero-rate"], - "context": ["view", "edit"] - } - } - }, - "webhook": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "webhook", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "A friendly name for the webhook.", "type": "string", "context": ["view", "edit"] }, - "status": { - "description": "Webhook status.", - "type": "string", - "default": "active", - "enum": ["active", "paused", "disabled"], - "context": ["view", "edit"] - }, - "topic": { "description": "Webhook topic.", "type": "string", "context": ["view", "edit"] }, - "resource": { - "description": "Webhook resource.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "event": { "description": "Webhook event.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "hooks": { - "description": "WooCommerce action names associated with the webhook.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "delivery_url": { - "description": "The URL where the webhook payload is delivered.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "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", - "context": ["edit"] - }, - "date_created": { - "description": "The date the webhook was created, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the webhook was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified": { - "description": "The date the webhook was last modified, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the webhook was last modified, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "system_status": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "system_status", - "type": "object", - "properties": { - "environment": { - "description": "Environment.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "home_url": { - "description": "Home URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "site_url": { - "description": "Site URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "store_id": { - "description": "WooCommerce Store Identifier.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "version": { - "description": "WooCommerce version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "log_directory": { - "description": "Log directory.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "log_directory_writable": { - "description": "Is log directory writable?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "wp_version": { - "description": "WordPress version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "wp_multisite": { - "description": "Is WordPress multisite?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "wp_memory_limit": { - "description": "WordPress memory limit.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "wp_debug_mode": { - "description": "Is WordPress debug mode active?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "wp_cron": { - "description": "Are WordPress cron jobs enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "language": { - "description": "WordPress language.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "server_info": { "description": "Server info.", "type": "string", "context": ["view"], "readonly": true }, - "php_version": { "description": "PHP version.", "type": "string", "context": ["view"], "readonly": true }, - "php_post_max_size": { - "description": "PHP post max size.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "php_max_execution_time": { - "description": "PHP max execution time.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "php_max_input_vars": { - "description": "PHP max input vars.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "curl_version": { - "description": "cURL version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "suhosin_installed": { - "description": "Is SUHOSIN installed?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "max_upload_size": { - "description": "Max upload size.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "mysql_version": { - "description": "MySQL version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "mysql_version_string": { - "description": "MySQL version string.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "default_timezone": { - "description": "Default timezone.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "fsockopen_or_curl_enabled": { - "description": "Is fsockopen/cURL enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "soapclient_enabled": { - "description": "Is SoapClient class enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "domdocument_enabled": { - "description": "Is DomDocument class enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "gzip_enabled": { - "description": "Is GZip enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "mbstring_enabled": { - "description": "Is mbstring enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "remote_post_successful": { - "description": "Remote POST successful?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "remote_post_response": { - "description": "Remote POST response.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "remote_get_successful": { - "description": "Remote GET successful?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "remote_get_response": { - "description": "Remote GET response.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "database": { - "description": "Database.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "wc_database_version": { - "description": "WC database version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "database_prefix": { - "description": "Database prefix.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "maxmind_geoip_database": { - "description": "MaxMind GeoIP database.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "database_tables": { - "description": "Database tables.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - } - } - }, - "active_plugins": { - "description": "Active plugins.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "inactive_plugins": { - "description": "Inactive plugins.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "dropins_mu_plugins": { - "description": "Dropins & MU plugins.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "theme": { - "description": "Theme.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "name": { "description": "Theme name.", "type": "string", "context": ["view"], "readonly": true }, - "version": { "description": "Theme version.", "type": "string", "context": ["view"], "readonly": true }, - "version_latest": { - "description": "Latest version of theme.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "author_url": { - "description": "Theme author URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "is_child_theme": { - "description": "Is this theme a child theme?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "has_woocommerce_support": { - "description": "Does the theme declare WooCommerce support?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "has_woocommerce_file": { - "description": "Does the theme have a woocommerce.php file?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "has_outdated_templates": { - "description": "Does this theme have outdated templates?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "overrides": { - "description": "Template overrides.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "parent_name": { - "description": "Parent theme name.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "parent_version": { - "description": "Parent theme version.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "parent_author_url": { - "description": "Parent theme author URL.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - } - } - }, - "settings": { - "description": "Settings.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "api_enabled": { - "description": "Legacy REST API enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "force_ssl": { "description": "SSL forced?", "type": "boolean", "context": ["view"], "readonly": true }, - "currency": { "description": "Currency.", "type": "string", "context": ["view"], "readonly": true }, - "currency_symbol": { - "description": "Currency symbol.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "currency_position": { - "description": "Currency position.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "thousand_separator": { - "description": "Thousand separator.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "decimal_separator": { - "description": "Decimal separator.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "number_of_decimals": { - "description": "Number of decimals.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "geolocation_enabled": { - "description": "Geolocation enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "taxonomies": { - "description": "Taxonomy terms for product/order statuses.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "product_visibility_terms": { - "description": "Terms in the product visibility taxonomy.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "wccom_connected": { - "description": "Is store connected to WooCommerce.com?", - "type": "string", - "context": ["view"], - "readonly": true - }, - "enforce_approved_download_dirs": { - "description": "Enforce approved download directories?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "HPOS_enabled": { - "description": "Is HPOS enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "order_datastore": { - "description": "Order datastore.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "HPOS_sync_enabled": { - "description": "Is HPOS sync enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - } - } - }, - "security": { - "description": "Security.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "secure_connection": { - "description": "Is the connection to your store secure?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "hide_errors": { - "description": "Hide errors from visitors?", - "type": "boolean", - "context": ["view"], - "readonly": true - } - } - }, - "pages": { - "description": "WooCommerce pages.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "post_type_counts": { - "description": "Total post count.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "logging": { - "description": "Logging.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "logging_enabled": { - "description": "Is logging enabled?", - "type": "boolean", - "context": ["view"], - "readonly": true - }, - "default_handler": { - "description": "The logging handler class.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "retention_period_days": { - "description": "The number of days log entries are retained.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "level_threshold": { - "description": "Minimum severity level.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "log_directory_size": { - "description": "The size of the log directory.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - } - } - }, - "system_status_tool": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "system_status_tool", - "type": "object", - "properties": { - "id": { "description": "A unique identifier for the tool.", "type": "string", "context": ["view", "edit"] }, - "name": { "description": "Tool name.", "type": "string", "context": ["view", "edit"] }, - "action": { "description": "What running the tool will do.", "type": "string", "context": ["view", "edit"] }, - "description": { "description": "Tool description.", "type": "string", "context": ["view", "edit"] }, - "success": { "description": "Did the tool run successfully?", "type": "boolean", "context": ["edit"] }, - "message": { "description": "Tool return message.", "type": "string", "context": ["edit"] } - } - }, - "shipping_method": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping_method", - "type": "object", - "properties": { - "id": { "description": "Method ID.", "type": "string", "context": ["view"], "readonly": true }, - "title": { "description": "Shipping method title.", "type": "string", "context": ["view"], "readonly": true }, - "description": { - "description": "Shipping method description.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "payment_gateway": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "payment_gateway", - "type": "object", - "properties": { - "id": { - "description": "Payment gateway ID.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "title": { - "description": "Payment gateway title on checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "description": { - "description": "Payment gateway description on checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "order": { "description": "Payment gateway sort order.", "type": "integer", "context": ["view", "edit"] }, - "enabled": { - "description": "Payment gateway enabled status.", - "type": "boolean", - "context": ["view", "edit"] - }, - "method_title": { - "description": "Payment gateway method title.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_description": { - "description": "Payment gateway method description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "settings": { - "description": "Payment gateway settings.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": ["view", "edit"], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { "description": "Setting value.", "type": "string", "context": ["view", "edit"] }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "data_index": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_index", - "type": "object", - "properties": { - "slug": { "description": "Data resource ID.", "type": "string", "context": ["view"], "readonly": true }, - "description": { - "description": "Data resource description.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "data_continents": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_continents", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "2 character continent code.", - "context": ["view"], - "readonly": true - }, - "name": { "type": "string", "description": "Full name of continent.", "context": ["view"], "readonly": true }, - "countries": { - "type": "array", - "description": "List of countries on this continent.", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "code": { - "type": "string", - "description": "ISO3166 alpha-2 country code.", - "context": ["view"], - "readonly": true - }, - "currency_code": { - "type": "string", - "description": "Default ISO4127 alpha-3 currency code for the country.", - "context": ["view"], - "readonly": true - }, - "currency_pos": { - "type": "string", - "description": "Currency symbol position for this country.", - "context": ["view"], - "readonly": true - }, - "decimal_sep": { - "type": "string", - "description": "Decimal separator for displayed prices for this country.", - "context": ["view"], - "readonly": true - }, - "dimension_unit": { - "type": "string", - "description": "The unit lengths are defined in for this country.", - "context": ["view"], - "readonly": true - }, - "name": { - "type": "string", - "description": "Full name of country.", - "context": ["view"], - "readonly": true - }, - "num_decimals": { - "type": "integer", - "description": "Number of decimal points shown in displayed prices for this country.", - "context": ["view"], - "readonly": true - }, - "states": { - "type": "array", - "description": "List of states in this country.", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "code": { "type": "string", "description": "State code.", "context": ["view"], "readonly": true }, - "name": { - "type": "string", - "description": "Full name of state.", - "context": ["view"], - "readonly": true - } - } - } - }, - "thousand_sep": { - "type": "string", - "description": "Thousands separator for displayed prices in this country.", - "context": ["view"], - "readonly": true - }, - "weight_unit": { - "type": "string", - "description": "The unit weights are defined in for this country.", - "context": ["view"], - "readonly": true - } - } - } - } - } - }, - "data_countries": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_countries", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "ISO3166 alpha-2 country code.", - "context": ["view"], - "readonly": true - }, - "name": { "type": "string", "description": "Full name of country.", "context": ["view"], "readonly": true }, - "states": { - "type": "array", - "description": "List of states in this country.", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "code": { "type": "string", "description": "State code.", "context": ["view"], "readonly": true }, - "name": { - "type": "string", - "description": "Full name of state.", - "context": ["view"], - "readonly": true - } - } - } - } - } - }, - "data_currencies": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_currencies", - "type": "object", - "properties": { - "code": { "type": "string", "description": "ISO4217 currency code.", "context": ["view"], "readonly": true }, - "name": { "type": "string", "description": "Full name of currency.", "context": ["view"], "readonly": true }, - "symbol": { "type": "string", "description": "Currency symbol.", "context": ["view"], "readonly": true } - } - }, - "marketing_recommendation": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_recommendation", - "type": "object", - "properties": { - "title": { "type": "string", "context": ["view"], "readonly": true }, - "description": { "type": "string", "context": ["view"], "readonly": true }, - "url": { "type": "string", "context": ["view"], "readonly": true }, - "direct_install": { "type": "string", "context": ["view"], "readonly": true }, - "icon": { "type": "string", "context": ["view"], "readonly": true }, - "product": { "type": "string", "context": ["view"], "readonly": true }, - "plugin": { "type": "string", "context": ["view"], "readonly": true }, - "categories": { "type": "array", "context": ["view"], "readonly": true, "items": { "type": "string" } }, - "subcategories": { - "type": "array", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "slug": { "type": "string", "context": ["view"], "readonly": true }, - "name": { "type": "string", "context": ["view"], "readonly": true } - } - } - }, - "tags": { - "type": "array", - "context": ["view"], - "readonly": true, - "items": { - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "slug": { "type": "string", "context": ["view"], "readonly": true }, - "name": { "type": "string", "context": ["view"], "readonly": true } - } - } - } - } - }, - "marketing_channel": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_channel", - "type": "object", - "properties": { - "slug": { - "description": "Unique identifier string for the marketing channel extension, also known as the plugin slug.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { - "description": "Name of the marketing channel.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "Description of the marketing channel.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "icon": { - "description": "Path to the channel icon.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "is_setup_completed": { - "type": "boolean", - "description": "Whether or not the marketing channel is set up.", - "context": ["view"], - "readonly": true - }, - "settings_url": { - "description": "URL to the settings page, or the link to complete the setup/onboarding if the channel has not been set up yet.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "product_listings_status": { - "description": "Status of the marketing channel's product listings.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "errors_count": { - "description": "Number of channel issues/errors (e.g. account-related errors, product synchronization issues, etc.).", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "marketing_campaign": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_campaign", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier for the marketing campaign.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "channel": { - "description": "The unique identifier for the marketing channel that this campaign belongs to.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "title": { - "description": "Title of the marketing campaign.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "manage_url": { - "description": "URL to the campaign management page.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "cost": { - "description": "Cost of the marketing campaign.", - "context": ["view"], - "readonly": true, - "type": "object", - "properties": { - "value": { "type": "string", "context": ["view"], "readonly": true }, - "currency": { "type": "string", "context": ["view"], "readonly": true } - } - }, - "sales": { - "description": "Sales of the marketing campaign.", - "context": ["view"], - "readonly": true, - "type": "object", - "properties": { - "value": { "type": "string", "context": ["view"], "readonly": true }, - "currency": { "type": "string", "context": ["view"], "readonly": true } - } - } - } - }, - "marketing_campaign_type": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "marketing_campaign_type", - "type": "object", - "properties": { - "id": { - "description": "The unique identifier for the marketing campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { - "description": "Name of the marketing campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "description": { - "description": "Description of the marketing campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "channel": { - "description": "The marketing channel that this campaign type belongs to.", - "type": "object", - "context": ["view"], - "readonly": true, - "properties": { - "slug": { - "description": "The unique identifier of the marketing channel that this campaign type belongs to.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "name": { - "description": "The name of the marketing channel that this campaign type belongs to.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "create_url": { - "description": "URL to the create campaign page for this campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "icon_url": { - "description": "URL to an image/icon for the campaign type.", - "type": "string", - "context": ["view"], - "readonly": true - } - } - }, - "options": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "options", - "type": "object", - "properties": { - "options": { - "type": "array", - "description": "Array of options with associated values.", - "context": ["view"], - "readonly": true - } - } - }, - "payment-gateway-suggestions": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "payment-gateway-suggestions", - "type": "object", - "properties": { - "content": { - "description": "Suggestion description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "id": { "description": "Suggestion ID.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "image": { "description": "Gateway image.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "is_visible": { - "description": "Suggestion visibility.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "plugins": { - "description": "Array of plugin slugs.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "recommendation_priority": { - "description": "Priority of recommendation.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "title": { "description": "Gateway title.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "transaction_processors": { - "description": "Array of transaction processors and their images.", - "type": "object", - "addtionalProperties": { "type": "string", "format": "uri" }, - "context": ["view", "edit"], - "readonly": true - } - } - }, - "upload_theme": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "upload_theme", - "type": "object", - "properties": { - "status": { - "description": "Theme installation status.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Theme installation message.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "theme": { "description": "Uploaded theme.", "type": "object", "context": ["view", "edit"], "readonly": true } - } - }, - "plugins": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "plugins", - "type": "object", - "properties": { - "slug": { "description": "Plugin slug.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Plugin name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "connectAction": { - "description": "Action that should be completed to connect Jetpack.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "onboarding_profile": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "onboarding_profile", - "type": "object", - "properties": { - "completed": { - "type": "boolean", - "description": "Whether or not the profile was completed.", - "context": ["view"], - "readonly": true - }, - "skipped": { - "type": "boolean", - "description": "Whether or not the profile was skipped.", - "context": ["view"], - "readonly": true - }, - "industry": { "type": "array", "description": "Industry.", "context": ["view"], "readonly": true }, - "product_types": { - "type": "array", - "description": "Types of products sold.", - "context": ["view"], - "readonly": true - }, - "product_count": { - "type": "string", - "description": "Number of products to be added.", - "context": ["view"], - "readonly": true, - "enum": ["0", "1-10", "11-100", "101-1000", "1000+"] - }, - "selling_venues": { - "type": "string", - "description": "Other places the store is selling products.", - "context": ["view"], - "readonly": true, - "enum": ["no", "other", "brick-mortar", "brick-mortar-other", "other-woocommerce"] - }, - "number_employees": { - "type": "string", - "description": "Number of employees of the store.", - "context": ["view"], - "readonly": true, - "enum": ["1", "<10", "10-50", "50-250", "+250", "not specified"] - }, - "revenue": { - "type": "string", - "description": "Current annual revenue of the store.", - "context": ["view"], - "readonly": true, - "enum": [ - "none", - "up-to-2500", - "2500-10000", - "10000-50000", - "50000-250000", - "more-than-250000", - "rather-not-say" - ] - }, - "other_platform": { - "type": "string", - "description": "Name of other platform used to sell.", - "context": ["view"], - "readonly": true, - "enum": ["shopify", "bigcommerce", "magento", "wix", "amazon", "ebay", "etsy", "squarespace", "other"] - }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed).", - "context": ["view"], - "readonly": true - }, - "business_extensions": { - "type": "array", - "description": "Extra business extensions to install.", - "context": ["view"], - "readonly": true - }, - "theme": { "type": "string", "description": "Selected store theme.", "context": ["view"], "readonly": true }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client.", - "context": ["view"], - "readonly": true - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", - "context": ["view"], - "readonly": true - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", - "context": ["view"], - "readonly": true - }, - "store_email": { - "type": "string", - "description": "Store email address.", - "context": ["view"], - "readonly": true - }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler.", - "context": ["view"], - "readonly": true - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped.", - "context": ["view"], - "readonly": true - } - } - }, - "onboarding_theme": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "onboarding_theme", - "type": "object", - "properties": { - "slug": { "description": "Theme slug.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Theme name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "status": { "description": "Theme status.", "type": "string", "context": ["view", "edit"], "readonly": true } - } - }, - "Install Async Schema": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "Install Async Schema", - "type": "object", - "properties": { - "type": "object", - "properties": { - "job_id": "integer", - "status": { "type": "string", "enum": ["pending", "complete", "failed"] } - } - } - }, - "Install and Activate Schema": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "Install and Activate Schema", - "type": "object", - "properties": { - "type": "object", - "properties": { - "install": { - "type": "object", - "properties": { - "installed": { "type": "array", "items": { "type": "string" } }, - "results": { "type": "array", "items": { "type": "string" } }, - "errors": { - "type": "object", - "properties": { - "errors": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - }, - "error_data": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - } - } - } - } - }, - "activate": { - "type": "object", - "properties": { - "activated": { "type": "array", "items": { "type": "string" } }, - "active": { "type": "array", "items": { "type": "string" } }, - "errors": { - "type": "object", - "properties": { - "errors": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - }, - "error_data": { - "type": "object", - "patternProperties": { "^.*$": { "type": "string" } }, - "items": { "type": "string" } - } - } - } - } - } - } - } - }, - "shipping-partner-suggestions": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "shipping-partner-suggestions", - "type": "array", - "items": [ - { - "type": "object", - "required": ["name", "is_visible", "available_layouts"], - "anyOf": [{ "required": "layout_row" }, { "required": "layout_column" }], - "properties": { - "name": { - "description": "Plugin name.", - "type": "string", - "required": true, - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Plugin slug used in https:/wordpress.org/plugins/{slug}.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "layout_row": { - "type": "object", - "properties": { - "image": { "type": "string", "description": "" }, - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - "icon": { "type": "string" }, - "title": { "type": "string" }, - "description": { "type": "string" } - } - } - } - } - }, - "layout_column": { - "type": "object", - "properties": { - "image": { "type": "string", "description": "" }, - "features": { - "type": "array", - "items": { - "type": "object", - "properties": { - "icon": { "type": "string" }, - "title": { "type": "string" }, - "description": { "type": "string" } - } - } - } - } - }, - "description": { - "description": "Description", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "learn_more_link": { - "description": "Learn more link .", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "is_visible": { - "description": "Suggestion visibility.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "available_layouts": { - "description": "Available layouts -- single, dual, or both", - "type": "array", - "items": { "type": "string", "enum": ["row", "column"] }, - "context": ["view", "edit"], - "readonly": true - } - } - } - ] - }, - "report_customers": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_customers", - "type": "object", - "properties": { - "id": { "description": "Customer ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "user_id": { "description": "User ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "name": { "description": "Name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "username": { "description": "Username.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "country": { - "description": "Country/Region.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "city": { "description": "City.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "state": { "description": "Region.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_registered": { - "description": "Date registered.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_registered_gmt": { - "description": "Date registered GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_last_active": { - "description": "Date last active.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_last_active_gmt": { - "description": "Date last active GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Order count.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "total_spend": { - "description": "Total spend.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "avg_order_value": { - "description": "Average order value", - "type": "number", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "leaderboard": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "leaderboard", - "type": "object", - "properties": { - "id": { "type": "string", "description": "Leaderboard ID.", "context": ["view"], "readonly": true }, - "label": { - "type": "string", - "description": "Displayed title for the leaderboard.", - "context": ["view"], - "readonly": true - }, - "headers": { - "type": "array", - "description": "Table headers.", - "context": ["view"], - "readonly": true, - "items": { - "type": "array", - "properties": { - "label": { - "description": "Table column header.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "rows": { - "type": "array", - "description": "Table rows.", - "context": ["view"], - "readonly": true, - "items": { - "type": "array", - "properties": { - "display": { - "description": "Table cell display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Table cell value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "format": { - "description": "Table cell format.", - "type": "string", - "context": ["view"], - "enum": ["currency", "number"], - "readonly": true, - "required": false - } - } - } - } - } - }, - "report_import": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_import", - "type": "object", - "properties": { - "status": { - "description": "Regeneration status.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Regenerate data message.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_export": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_export", - "type": "object", - "properties": { - "status": { - "description": "Export status.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Export status message.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "export_id": { "description": "Export ID.", "type": "string", "context": ["view", "edit"], "readonly": true } - } - }, - "report_export_status": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_export_status", - "type": "object", - "properties": { - "percent_complete": { - "description": "Percentage complete.", - "type": "int", - "context": ["view", "edit"], - "readonly": true - }, - "download_url": { - "description": "Export download URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_products": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_products", - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "items_sold": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of items sold." - }, - "net_revenue": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Total Net sales of all items sold." - }, - "orders_count": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of orders product appeared in." - }, - "extended_info": { - "name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Product name." }, - "price": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Product price." - }, - "image": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product image." - }, - "permalink": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product link." - }, - "category_ids": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "Product category IDs." - }, - "stock_status": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory status." - }, - "stock_quantity": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory quantity." - }, - "low_stock_amount": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory threshold for low stock." - }, - "variations": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "Product variations IDs." - }, - "sku": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Product SKU." } - } - } - }, - "report_varitations": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_varitations", - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "variation_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "items_sold": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of items sold." - }, - "net_revenue": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Total Net sales of all items sold." - }, - "orders_count": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Number of orders product appeared in." - }, - "extended_info": { - "name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Product name." }, - "price": { - "type": "number", - "readonly": true, - "context": ["view", "edit"], - "description": "Product price." - }, - "image": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product image." - }, - "permalink": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product link." - }, - "attributes": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "Product attributes." - }, - "stock_status": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory status." - }, - "stock_quantity": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory quantity." - }, - "low_stock_amount": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product inventory threshold for low stock." - } - } - } - }, - "report_products_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_products_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Products sold", - "description": "Number of product items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - } - } - } - } - } - }, - "report_variations_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_variations_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "items_sold": { - "title": "Variations Sold", - "description": "Number of variation items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "segment_label": { - "description": "Human readable segment label, either product or variation name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - } - } - } - } - } - } - } - } - } - } - }, - "report_revenue_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_revenue_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - } - } - } - } - } - }, - "products": { - "description": "Products sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_sales": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "net_revenue": { - "description": "Net sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons": { - "description": "Amount discounted by coupons.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "coupons_count": { - "description": "Unique coupons count.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "shipping": { - "title": "Shipping", - "description": "Total of shipping.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "taxes": { - "description": "Total of taxes.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "refunds": { - "title": "Returns", - "description": "Total of returns.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "gross_sales": { - "description": "Gross sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - } - } - } - } - } - } - } - } - } - } - } - } - }, - "report_orders": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_orders", - "type": "object", - "properties": { - "order_id": { "description": "Order ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "order_number": { - "description": "Order Number.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "Date the order was created, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "Date the order was created, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "status": { "description": "Order status.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "customer_id": { - "description": "Customer ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "num_items_sold": { - "description": "Number of items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "net_total": { - "description": "Net total revenue.", - "type": "float", - "context": ["view", "edit"], - "readonly": true - }, - "total_formatted": { - "description": "Net total revenue (formatted).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_type": { - "description": "Returning or new customer.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extended_info": { - "products": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "List of order product IDs, names, quantities." - }, - "coupons": { - "type": "array", - "readonly": true, - "context": ["view", "edit"], - "description": "List of order coupons." - }, - "customer": { - "type": "object", - "readonly": true, - "context": ["view", "edit"], - "description": "Order customer information." - }, - "attribution": { - "type": "object", - "readonly": true, - "context": ["view", "edit"], - "description": "Order attribution information." - } - } - } - }, - "report_orders_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_orders_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "download_count": { - "title": "Downloads", - "description": "Number of downloads.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "download_count": { - "title": "Downloads", - "description": "Number of downloads.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - } - } - } - } - } - }, - "report_categories": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_categories", - "type": "object", - "properties": { - "category_id": { - "description": "Category ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "items_sold": { - "description": "Amount of items sold.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "net_revenue": { - "description": "Total sales.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "products_count": { - "description": "Amount of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "extended_info": { - "name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Category name." } - } - } - }, - "report_taxes": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_taxes", - "type": "object", - "properties": { - "tax_rate_id": { - "description": "Tax rate ID", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Tax rate name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "tax_rate": { "description": "Tax rate.", "type": "number", "context": ["view", "edit"], "readonly": true }, - "country": { - "description": "Country/Region.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "state": { "description": "State.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "priority": { "description": "Priority.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "total_tax": { "description": "Total tax.", "type": "number", "context": ["view", "edit"], "readonly": true }, - "order_tax": { "description": "Order tax.", "type": "number", "context": ["view", "edit"], "readonly": true }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_taxes_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_taxes_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "total_tax": { - "description": "Total tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "order_tax": { - "description": "Order tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "shipping_tax": { - "description": "Shipping tax.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "tax_codes": { - "description": "Amount of tax codes.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - } - } - } - } - } - } - } - }, - "report_coupons": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_coupons", - "type": "object", - "properties": { - "coupon_id": { - "description": "Coupon ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "description": "Number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "extended_info": { - "code": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "Coupon code." }, - "date_created": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon creation date." - }, - "date_created_gmt": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon creation date in GMT." - }, - "date_expires": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon expiration date." - }, - "date_expires_gmt": { - "type": "date-time", - "readonly": true, - "context": ["view", "edit"], - "description": "Coupon expiration date in GMT." - }, - "discount_type": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "enum": ["percent", "fixed_cart", "fixed_product"], - "description": "Coupon discount type." - } - } - } - }, - "report_coupons_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_coupons_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - } - } - } - } - } - }, - "intervals": { - "description": "Reports data grouped by intervals.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "interval": { - "description": "Type of interval.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "enum": ["day", "week", "month", "year"] - }, - "date_start": { - "description": "The date the report start, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_start_gmt": { - "description": "The date the report start, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end": { - "description": "The date the report end, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_end_gmt": { - "description": "The date the report end, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - }, - "segments": { - "description": "Reports data grouped by segment condition.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "segment_id": { - "description": "Segment identificator.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "subtotals": { - "description": "Interval subtotals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "amount": { - "description": "Net discount amount.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "indicator": true, - "format": "currency" - }, - "coupons_count": { - "description": "Number of coupons.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "orders_count": { - "title": "Discounted orders", - "description": "Number of discounted orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "indicator": true - } - } - } - } - } - } - } - } - } - } - } - } - }, - "report_stock": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_stock", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Product name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "stock_status": { - "description": "Stock status.", - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "context": ["view", "edit"], - "readonly": true - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "manage_stock": { - "description": "Manage stock.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "report_customers_stats": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_customers_stats", - "type": "object", - "properties": { - "totals": { - "description": "Totals data.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "customers_count": { - "description": "Number of customers.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "avg_orders_count": { - "description": "Average number of orders.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "avg_total_spend": { - "description": "Average total spend per customer.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - }, - "avg_avg_order_value": { - "description": "Average AOV per customer.", - "type": "number", - "context": ["view", "edit"], - "readonly": true, - "format": "currency" - } - } - } - } - }, - "report_downloads": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_downloads", - "type": "object", - "properties": { - "id": { "type": "integer", "readonly": true, "context": ["view", "edit"], "description": "ID." }, - "product_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "Product ID." - }, - "date": { - "description": "The date of the download, in the site's time zone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_gmt": { - "description": "The date of the download, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "download_id": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Download ID." - }, - "file_name": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "File name." }, - "file_path": { "type": "string", "readonly": true, "context": ["view", "edit"], "description": "File URL." }, - "order_id": { "type": "integer", "readonly": true, "context": ["view", "edit"], "description": "Order ID." }, - "order_number": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "Order Number." - }, - "user_id": { - "type": "integer", - "readonly": true, - "context": ["view", "edit"], - "description": "User ID for the downloader." - }, - "username": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "User name of the downloader." - }, - "ip_address": { - "type": "string", - "readonly": true, - "context": ["view", "edit"], - "description": "IP address for the downloader." - } - } - }, - "report_performance_indicator": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "report_performance_indicator", - "type": "object", - "properties": { - "stat": { - "description": "Unique identifier for the resource.", - "type": "string", - "context": ["view", "edit"], - "readonly": true, - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - }, - "chart": { - "description": "The specific chart this stat referrers to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "label": { - "description": "Human readable label for the stat.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "note": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "note", - "type": "object", - "properties": { - "id": { "description": "ID of the note record.", "type": "integer", "context": ["view"], "readonly": true }, - "name": { - "description": "Name of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "The type of the note (eg error, warning, etc).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "locale": { - "description": "Locale used for the note title and content.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "title": { - "description": "Title of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "content": { - "description": "Content of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "content_data": { - "description": "Content data for the note. JSON string. Available for re-localisation.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "The status of the note (e.g. unactioned, actioned).", - "type": "string", - "context": ["view", "edit"] - }, - "source": { - "description": "Source of the note.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_created": { - "description": "Date the note was created.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "Date the note was created (GMT).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_reminder": { - "description": "Date after which the user should be reminded of the note, if any.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "date_reminder_gmt": { - "description": "Date after which the user should be reminded of the note, if any (GMT).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "is_snoozable": { - "description": "Whether or not a user can request to be reminded about the note.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "actions": { - "description": "An array of actions, if any, for the note.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "layout": { - "description": "The layout of the note (eg banner, thumbnail, plain).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "The image of the note, if any.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "is_deleted": { - "description": "Registers whether the note is deleted or not", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_read": { - "description": "Registers whether the note is read or not", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "data_download_ips": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "data_download_ips", - "type": "object", - "properties": { - "user_ip_address": { "type": "string", "description": "IP address.", "context": ["view"], "readonly": true } - } - }, - "Count Low in Stock Items": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "Count Low in Stock Items", - "type": "object", - "properties": { "type": "object", "properties": { "total": "integer" } } - }, - "cart": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart", - "type": "object", - "properties": { - "coupons": { - "description": "List of applied basket coupons.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "The coupon's unique code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "totals": { - "description": "Total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "shipping_rates": { - "description": "List of available shipping rates for the basket.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "package_id": { - "description": "The ID of the package the shipping rates belong to.", - "type": ["integer", "string"], - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Name of the package.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "destination": { - "description": "Shipping destination address.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "address_1": { - "description": "First line of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "address_2": { - "description": "Second line of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "city": { - "description": "City of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "state": { - "description": "ISO code, or name, for the state, province, or district of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "postcode": { - "description": "Zip or Postcode of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "country": { - "description": "ISO code for the country of the address being shipped to.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "items": { - "description": "List of basket items the returned shipping rates apply to.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Name of the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of the item in the current package.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "shipping_rates": { - "description": "List of shipping rates.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "rate_id": { - "description": "ID of the shipping rate.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Name of the shipping rate, e.g. Express shipping.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Description of the shipping rate, e.g. Dispatched via Royal Mail.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "delivery_time": { - "description": "Delivery time estimate text, e.g. 3-5 business days.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Price of this shipping rate using the smallest unit of the currency.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxes": { - "description": "Taxes applied to this shipping rate using the smallest unit of the currency.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "method_id": { - "description": "ID of the shipping method that provided the rate.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "instance_id": { - "description": "Instance ID of the shipping method that provided the rate.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "meta_data": { - "description": "Meta data attached to the shipping rate.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "key": { - "description": "Meta key.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Meta value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "selected": { - "description": "True if this is the rate currently selected by the customer for the basket.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - } - }, - "shipping_address": { - "description": "Current set shipping address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "billing_address": { - "description": "Current set billing address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "email": { - "description": "Email", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "items": { - "description": "List of basket items.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "The item type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "id": { - "description": "The item product or variation ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of this item.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "quantity_limits": { - "description": "How the quantity of this item should be controlled, for example, any limits in place.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "minimum": { - "description": "The minimum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - }, - "editable": { - "description": "If the quantity is editable or fixed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true, - "default": true - } - } - }, - "name": { - "description": "Product name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Stock keeping unit, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "backorders_allowed": { - "description": "True if backorders are allowed past stock availability.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "show_backorder_badge": { - "description": "True if the product is on backorder.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Image name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "item_data": { - "description": "Metadata related to the item", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "Name of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Value of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "display": { - "description": "Optionally, how the metadata value should be displayed to the user.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "prices": { - "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.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "raw_prices": { - "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "precision": { - "description": "Decimal precision of the returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "totals": { - "description": "Item total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal": { - "description": "Line subtotal (the price of the product before coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal_tax": { - "description": "Line subtotal tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total": { - "description": "Line total (the price of the product after coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total_tax": { - "description": "Line total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "catalog_visibility": { - "description": "Whether the product is visible in the catalogue", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [], "readonly": true } - } - } - }, - "items_count": { - "description": "Number of items in the basket.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "items_weight": { - "description": "Total weight (in grams) of all products in the basket.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "cross_sells": { - "description": "List of cross-sells items related to basket items.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Product slug.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "parent": { - "description": "ID of the parent product, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "Product type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "variation": { - "description": "Product variation attributes, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "on_sale": { - "description": "Is the product on sale?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "prices": { - "description": "Price data provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "price_html": { - "description": "Price string formatted as HTML.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "average_rating": { - "description": "Reviews average rating.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "review_count": { - "description": "Amount of reviews that the product has.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Image name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "categories": { - "description": "List of categories, if applicable.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Category name", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Category slug", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "link": { - "description": "Category link", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "tags": { - "description": "List of tags, if applicable.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Tag name", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "Tag slug", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "link": { - "description": "Tag link", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - }, - "attributes": { - "description": "List of attributes (taxonomy terms) assigned to the product. For variable products, these are mapped to variations (see the `variations` field).", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "The attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "taxonomy": { - "description": "The attribute taxonomy, or null if the attribute is not taxonomy based.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "has_variations": { - "description": "True if this attribute is used by product variations.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "terms": { - "description": "List of assigned attribute terms.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "The term ID, or 0 if the attribute is not a global attribute.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "The term name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "The term slug.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "default": { - "description": "If this is a default attribute", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - } - } - }, - "readonly": true - }, - "variations": { - "description": "List of variation IDs, if applicable.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "id": { - "description": "The attribute ID, or 0 if the attribute is not taxonomy based.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "attributes": { - "description": "List of variation attributes.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "name": { - "description": "The attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "The assigned attribute.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "readonly": true - } - } - }, - "readonly": true - }, - "has_options": { - "description": "Does the product have additional options before it can be added to the basket?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_purchasable": { - "description": "Is the product purchasable?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_in_stock": { - "description": "Is the product in stock?", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "is_on_backorder": { - "description": "Is the product stock backordered? This will also return false if backorder notifications are turned off.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "add_to_cart": { - "description": "Add to basket button parameters.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "text": { - "description": "Button text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Button description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "url": { - "description": "Add to basket URL.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "minimum": { - "description": "The minimum quantity that can be added to the basket.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity that can be added to the basket.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - } - } - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [], "readonly": true } - } - } - }, - "needs_payment": { - "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_shipping": { - "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "has_calculated_shipping": { - "description": "True if the basket meets the criteria for showing shipping costs, and rates have been calculated and included in the totals.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "fees": { - "description": "List of basket fees.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the fee within the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Fee name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "totals": { - "description": "Fee total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total": { - "description": "Total amount for this fee.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Total tax amount for this fee.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "totals": { - "description": "Basket total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items": { - "description": "Total price of items in the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items_tax": { - "description": "Total tax on items in the basket.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_fees": { - "description": "Total price of any applied fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_fees_tax": { - "description": "Total tax on fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping": { - "description": "Total price of shipping. If shipping has not been calculated, a null response will be sent.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping_tax": { - "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "total_price": { - "description": "Total price the customer will pay.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Total tax applied to items and shipping.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "tax_lines": { - "description": "Lines of taxes applied to items and shipping.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "The amount of tax charged.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate": { - "description": "The rate at which tax is applied.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "errors": { - "description": "List of basket item errors, for example, items in the basket which are out of stock.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Error message", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "payment_methods": { - "description": "List of available payment method IDs that can be used to process the order.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "payment_requirements": { - "description": "List of required payment gateway features to process the order.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "cart_coupon": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart_coupon", - "type": "object", - "properties": { - "code": { "description": "The coupon's unique code.", "type": "string", "context": ["view", "edit"] }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "context": ["view", "edit"] - }, - "totals": { - "description": "Total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "cart-extensions": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart-extensions", - "type": "object", - "properties": [] - }, - "cart_item": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "cart_item", - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { "description": "The item type.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "id": { - "description": "The item product or variation ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of this item.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "quantity_limits": { - "description": "How the quantity of this item should be controlled, for example, any limits in place.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "minimum": { - "description": "The minimum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - }, - "editable": { - "description": "If the quantity is editable or fixed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true, - "default": true - } - } - }, - "name": { "description": "Product name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Stock keeping unit, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "backorders_allowed": { - "description": "True if backorders are allowed past stock availability.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "show_backorder_badge": { - "description": "True if the product is on backorder.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "name": { "description": "Image name.", "type": "string", "context": ["view", "edit"] }, - "alt": { "description": "Image alternative text.", "type": "string", "context": ["view", "edit"] } - } - } - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "item_data": { - "description": "Metadata related to the item", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "Name of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Value of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "display": { - "description": "Optionally, how the metadata value should be displayed to the user.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "prices": { - "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.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "raw_prices": { - "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "precision": { - "description": "Decimal precision of the returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "totals": { - "description": "Item total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal": { - "description": "Line subtotal (the price of the product before coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal_tax": { - "description": "Line subtotal tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total": { - "description": "Line total (the price of the product after coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total_tax": { - "description": "Line total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "catalog_visibility": { - "description": "Whether the product is visible in the catalogue", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "checkout": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "checkout", - "type": "object", - "properties": { - "order_id": { - "description": "The order ID to process during checkout.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Order status. Payment providers will update this value after payment.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_key": { - "description": "Order key used to check validity or protect access to certain order data.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_number": { - "description": "Order number used for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "customer_id": { - "description": "Customer ID if registered. Will return 0 for guests.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true }, - "email": { "description": "Email", "type": "string", "context": ["view", "edit"], "required": true } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true } - } - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "context": ["view", "edit"], - "enum": ["bacs", "cheque", "cod"] - }, - "create_account": { - "description": "Whether to create a new user account as part of order processing.", - "type": "boolean", - "context": ["view", "edit"] - }, - "payment_result": { - "description": "Result of payment processing, or false if not yet processed.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "payment_status": { - "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", - "readonly": true, - "type": "string" - }, - "payment_details": { - "description": "An array of data being returned from the payment gateway.", - "readonly": true, - "type": "array", - "items": { - "type": "object", - "properties": { "key": { "type": "string" }, "value": { "type": "string" } } - } - }, - "redirect_url": { - "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", - "readonly": true, - "type": "string" - } - } - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "context": ["view", "edit"], - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "context": ["view", "edit"], - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": ["object", "null"], - "context": ["view", "edit"], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": ["string", "null"], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": ["string", "null"], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": ["string", "null"], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": ["string", "null"], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": ["string", "null"], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": ["string", "null"], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": ["string", "null"], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": ["string", "null"], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": ["string", "null"], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": ["string", "null"], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": ["string", "null"], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": ["string", "null"], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": ["string", "null"], - "context": [] - } - } - } - } - } - } - }, - "checkout-order": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "checkout-order", - "type": "object", - "properties": { - "order_id": { - "description": "The order ID to process during checkout.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Order status. Payment providers will update this value after payment.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_key": { - "description": "Order key used to check validity or protect access to certain order data.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "order_number": { - "description": "Order number used for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "context": ["view", "edit"] - }, - "customer_id": { - "description": "Customer ID if registered. Will return 0 for guests.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true }, - "email": { "description": "Email", "type": "string", "context": ["view", "edit"], "required": true } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "company": { "description": "Company", "type": "string", "context": ["view", "edit"], "required": true }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "city": { "description": "City", "type": "string", "context": ["view", "edit"], "required": true }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true - }, - "phone": { "description": "Phone", "type": "string", "context": ["view", "edit"], "required": true } - } - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "context": ["view", "edit"], - "enum": ["bacs", "cheque", "cod"] - }, - "payment_result": { - "description": "Result of payment processing, or false if not yet processed.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "payment_status": { - "description": "Status of the payment returned by the gateway. One of success, pending, failure, error.", - "readonly": true, - "type": "string" - }, - "payment_details": { - "description": "An array of data being returned from the payment gateway.", - "readonly": true, - "type": "array", - "items": { - "type": "object", - "properties": { "key": { "type": "string" }, "value": { "type": "string" } } - } - }, - "redirect_url": { - "description": "A URL to redirect the customer after checkout. This could be, for example, a link to the payment processors website.", - "readonly": true, - "type": "string" - } - } - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "context": ["view", "edit"], - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "context": ["view", "edit"], - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": ["object", "null"], - "context": ["view", "edit"], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": ["string", "null"], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": ["string", "null"], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": ["string", "null"], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": ["string", "null"], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": ["string", "null"], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": ["string", "null"], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": ["string", "null"], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": ["string", "null"], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": ["string", "null"], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": ["string", "null"], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": ["string", "null"], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": ["string", "null"], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": ["string", "null"], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": ["string", "null"], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": ["string", "null"], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": ["string", "null"], - "context": [] - } - } - } - } - } - } - }, - "order": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "order", - "type": "object", - "properties": { - "id": { "description": "The order ID.", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "items": { - "description": "Line items data.", - "type": "array", - "context": ["view", "edit"], - "items": { - "type": "object", - "properties": { - "key": { - "description": "Unique identifier for the item.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "type": { - "description": "The item type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "id": { - "description": "The item product or variation ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "quantity": { - "description": "Quantity of this item.", - "type": "number", - "context": ["view", "edit"], - "readonly": true - }, - "quantity_limits": { - "description": "How the quantity of this item should be controlled, for example, any limits in place.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "minimum": { - "description": "The minimum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "maximum": { - "description": "The maximum quantity allowed for this line item.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "multiple_of": { - "description": "The amount that quantities increment by. Quantity must be an multiple of this value.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true, - "default": 1 - }, - "editable": { - "description": "If the quantity is editable or fixed.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true, - "default": true - } - } - }, - "name": { - "description": "Product name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "short_description": { - "description": "Product short description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Product full description in HTML format.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sku": { - "description": "Stock keeping unit, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "low_stock_remaining": { - "description": "Quantity left in stock if stock is low, or null if not applicable.", - "type": ["integer", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "backorders_allowed": { - "description": "True if backorders are allowed past stock availability.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "show_backorder_badge": { - "description": "True if the product is on backorder.", - "type": ["boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "sold_individually": { - "description": "If true, only one item of this product is allowed for purchase in a single order.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Product URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "images": { - "description": "List of images.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"], - "readonly": true - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "name": { - "description": "Image name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "item_data": { - "description": "Metadata related to the item", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "Name of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "value": { - "description": "Value of the metadata.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "display": { - "description": "Optionally, how the metadata value should be displayed to the user.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "prices": { - "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.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price_range": { - "description": "Price range, if applicable.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "min_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_amount": { - "description": "Price amount.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "raw_prices": { - "description": "Raw unrounded product prices used in calculations. Provided using a higher unit of precision than the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "precision": { - "description": "Decimal precision of the returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "Current product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "regular_price": { - "description": "Regular product price.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "sale_price": { - "description": "Sale product price, if applicable.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - "totals": { - "description": "Item total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal": { - "description": "Line subtotal (the price of the product before coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_subtotal_tax": { - "description": "Line subtotal tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total": { - "description": "Line total (the price of the product after coupon discounts have been applied).", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "line_total_tax": { - "description": "Line total tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "catalog_visibility": { - "description": "Whether the product is visible in the catalogue", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "extensions": { "type": "object", "context": ["view", "edit"], "properties": [], "readonly": true } - } - } - }, - "totals": { - "description": "Order totals.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "subtotal": { - "description": "Subtotal of the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping": { - "description": "Total price of shipping.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "total_fees": { - "description": "Total price of any applied fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_tax": { - "description": "Total tax applied to the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_refund": { - "description": "Total refund applied to the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_price": { - "description": "Total price the customer will pay.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items": { - "description": "Total price of items in the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_items_tax": { - "description": "Total tax on items in the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_fees_tax": { - "description": "Total tax on fees.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount from applied coupons.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_shipping_tax": { - "description": "Total tax on shipping. If shipping has not been calculated, a null response will be sent.", - "type": ["string", "null"], - "context": ["view", "edit"], - "readonly": true - }, - "tax_lines": { - "description": "Lines of taxes applied to items and shipping.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the tax.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "price": { - "description": "The amount of tax charged.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "rate": { - "description": "The rate at which tax is applied.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "coupons": { - "description": "List of applied basket coupons.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "The coupon's unique code.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "totals": { - "description": "Total amounts provided using the smallest unit of the currency.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount": { - "description": "Total discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "total_discount_tax": { - "description": "Total tax removed due to discount applied by this coupon.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "shipping_address": { - "description": "Current set shipping address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "billing_address": { - "description": "Current set billing address for the customer.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "company": { - "description": "Company", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "city": { - "description": "City", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - }, - "email": { - "description": "Email", - "type": "string", - "context": ["view", "edit"], - "required": true, - "readonly": true - } - } - }, - "needs_payment": { - "description": "True if the basket needs payment. False for baskets with only free products and no shipping costs.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "needs_shipping": { - "description": "True if the basket needs shipping. False for baskets with only digital goods or stores with no shipping methods set-up.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "errors": { - "description": "List of basket item errors, for example, items in the basket which are out of stock.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "message": { - "description": "Error message", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "payment_requirements": { - "description": "List of required payment gateway features to process the order.", - "type": "array", - "context": ["view", "edit"], - "readonly": true - }, - "status": { - "description": "Status of the order.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "term": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "term", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Term name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "slug": { - "description": "String based identifier for the term.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Term description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "parent": { - "description": "Parent term ID, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "count": { - "description": "Number of objects (posts of any type) assigned to the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "product-category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product-category", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "name": { "description": "Term name.", "type": "string", "context": ["view", "edit"], "readonly": true }, - "slug": { - "description": "String based identifier for the term.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "Term description.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "parent": { - "description": "Parent term ID, if applicable.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "count": { - "description": "Number of objects (posts of any type) assigned to the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "image": { - "description": "Category image.", - "type": "object", - "context": ["view", "edit", "embed"], - "readonly": true, - "properties": { - "id": { "description": "Image ID.", "type": "integer", "context": ["view", "edit"] }, - "src": { - "description": "Full size image URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "thumbnail": { - "description": "Thumbnail URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit"] - }, - "srcset": { - "description": "Thumbnail srcset for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "sizes": { - "description": "Thumbnail sizes for responsive images.", - "type": "string", - "context": ["view", "edit"] - }, - "name": { "description": "Image name.", "type": "string", "context": ["view", "edit"] }, - "alt": { "description": "Image alternative text.", "type": "string", "context": ["view", "edit"] } - } - }, - "review_count": { - "description": "Number of reviews for products in this category.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "permalink": { - "description": "Category URL.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "product-collection-data": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product-collection-data", - "type": "object", - "properties": { - "price_range": { - "description": "Min and max prices found in collection of products, provided using the smallest unit of the currency.", - "type": ["object", "null"], - "context": ["view", "edit"], - "readonly": true, - "properties": { - "currency_code": { - "description": "Currency code (in ISO format) for returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_symbol": { - "description": "Currency symbol for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_minor_unit": { - "description": "Currency minor unit (number of digits after the decimal separator) for returned prices.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "currency_decimal_separator": { - "description": "Decimal separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_thousand_separator": { - "description": "Thousand separator for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_prefix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "currency_suffix": { - "description": "Price prefix for the currency which can be used to format returned prices.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "min_price": { - "description": "Minimum price found in collection of products.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "max_price": { - "description": "Maximum price found in collection of products.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "attribute_counts": { - "description": "Returns number of products within attribute terms.", - "type": ["array", "null"], - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "term": { "description": "Term ID", "type": "integer", "context": ["view", "edit"], "readonly": true }, - "count": { - "description": "Number of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "rating_counts": { - "description": "Returns number of products with each average rating.", - "type": ["array", "null"], - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "rating": { - "description": "Average rating", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "count": { - "description": "Number of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - }, - "stock_status_counts": { - "description": "Returns number of products with each stock status.", - "type": ["array", "null"], - "context": ["view", "edit"], - "readonly": true, - "items": { - "type": "object", - "properties": { - "status": { "description": "Status", "type": "string", "context": ["view", "edit"], "readonly": true }, - "count": { - "description": "Number of products.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - } - } - } - } - } - }, - "ai/store-title": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/store-title", - "type": "object", - "properties": [] - }, - "ai/images": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/images", - "type": "object", - "properties": [] - }, - "ai/patterns": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/patterns", - "type": "object", - "properties": [] - }, - "ai/product": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/product", - "type": "object", - "properties": [] - }, - "ai/products": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/products", - "type": "object", - "properties": [] - }, - "ai/business-description": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/business-description", - "type": "object", - "properties": [] - }, - "ai/store-info": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "ai/store-info", - "type": "object", - "properties": [] - }, - "patterns": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "patterns", - "type": "object", - "properties": [] - }, - "webhook_delivery": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "webhook_delivery", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "context": ["view"], - "readonly": true - }, - "duration": { - "description": "The delivery duration, in seconds.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "summary": { - "description": "A friendly summary of the response including the HTTP response code, message, and body.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "request_url": { - "description": "The URL where the webhook was delivered.", - "type": "string", - "format": "uri", - "context": ["view"], - "readonly": true - }, - "request_headers": { - "description": "Request headers", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "request_body": { "description": "Request body", "type": "string", "context": ["view"], "readonly": true }, - "response_code": { - "description": "The HTTP response code from the receiving server.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "response_message": { - "description": "The HTTP response message from the receiving server.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "response_headers": { - "description": "Array of the response headers from the receiving server.", - "type": "array", - "context": ["view"], - "readonly": true, - "items": { "type": "string" } - }, - "response_body": { - "description": "The response body from the receiving server.", - "type": "string", - "context": ["view"], - "readonly": true - }, - "date_created": { - "description": "The date the webhook delivery was logged, in the site's timezone.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the webhook delivery was logged, as GMT.", - "type": "date-time", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "post": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "post", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "format": { - "description": "The format for the post.", - "type": "string", - "enum": ["standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio"], - "context": ["view", "edit"] - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "sticky": { - "description": "Whether or not the post should be treated as sticky.", - "type": "boolean", - "context": ["view", "edit"] - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "categories": { - "description": "The terms assigned to the object in the category taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - }, - "tags": { - "description": "The terms assigned to the object in the post_tag taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-sticky", - "title": "The current user can sticky this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { "type": "object", "properties": { "sticky": { "type": "boolean" } } } - }, - { - "rel": "https:/api.w.org/action-assign-author", - "title": "The current user can change the author on this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } - }, - { - "rel": "https:/api.w.org/action-assign-categories", - "title": "The current user can assign terms in the category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "categories": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-categories", - "title": "The current user can create terms in the category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "categories": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-assign-tags", - "title": "The current user can assign terms in the post_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "tags": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-tags", - "title": "The current user can create terms in the post_tag taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/posts/{id}", - "targetSchema": { - "type": "object", - "properties": { "tags": { "type": "array", "items": { "type": "integer" } } } - } - } - ] - }, - "post-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "post-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "page": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "page", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "context": ["view", "edit"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "menu_order": { - "description": "The order of the post in relation to other posts.", - "type": "integer", - "context": ["view", "edit"] - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-author", - "title": "The current user can change the author on this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/pages/{id}", - "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } - } - ] - }, - "page-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "page-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { "footnotes": { "type": "string", "description": "", "default": "" } } - }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "attachment": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "attachment", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "context": ["view", "edit"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "permalink_template": { - "description": "Permalink template for the post.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "generated_slug": { - "description": "Slug automatically generated from the post title.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "class_list": { - "description": "An array of the class names for the post container element.", - "type": "array", - "context": ["view", "edit"], - "readonly": true, - "items": { "type": "string" } - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": ["open", "closed"], - "context": ["view", "edit"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "alt_text": { - "description": "Alternative text to display when attachment is not displayed.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "caption": { - "description": "The attachment caption.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Caption for the attachment, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML caption for the attachment, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "description": { - "description": "The attachment description.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Description for the attachment, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML description for the attachment, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "media_type": { - "description": "Attachment type.", - "type": "string", - "enum": ["image", "file"], - "context": ["view", "edit", "embed"], - "readonly": true - }, - "mime_type": { - "description": "The attachment MIME type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "media_details": { - "description": "Details about the media file, specific to its type.", - "type": "object", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "post": { - "description": "The ID for the associated post of the attachment.", - "type": "integer", - "context": ["view", "edit"] - }, - "source_url": { - "description": "URL to the original attachment file.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "missing_image_sizes": { - "description": "List of the missing image sizes of the attachment.", - "type": "array", - "items": { "type": "string" }, - "context": ["edit"], - "readonly": true - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-author", - "title": "The current user can change the author on this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/media/{id}", - "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } - } - ] - }, - "nav_menu_item": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "nav_menu_item", - "type": "object", - "properties": { - "title": { - "description": "The title for the object.", - "type": ["string", "object"], - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the object.", - "type": "integer", - "default": 0, - "minimum": 0, - "context": ["view", "edit", "embed"], - "readonly": true - }, - "type_label": { - "description": "The singular label used to describe this type of menu item.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "type": { - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "type": "string", - "enum": ["taxonomy", "post_type", "post_type_archive", "custom"], - "context": ["view", "edit", "embed"], - "default": "custom" - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "default": "publish", - "context": ["view", "edit", "embed"] - }, - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "minimum": 0, - "default": 0, - "context": ["view", "edit", "embed"] - }, - "attr_title": { - "description": "Text for the title attribute of the link element for this menu item.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "classes": { - "description": "Class names for the link element of this menu item.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The description of this menu item.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "menu_order": { - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", - "context": ["view", "edit", "embed"], - "type": "integer", - "minimum": 1, - "default": 1 - }, - "object": { - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", - "context": ["view", "edit", "embed"], "type": "string" }, - "object_id": { - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.", - "context": ["view", "edit", "embed"], - "type": "integer", - "minimum": 0, - "default": 0 - }, - "target": { - "description": "The target attribute of the link element for this menu item.", - "type": "string", - "context": ["view", "edit", "embed"], - "enum": ["_blank", ""] - }, - "url": { - "description": "The URL to which this menu item points.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"] - }, - "xfn": { - "description": "The XFN relationship expressed in the link of this menu item.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "invalid": { - "description": "Whether the menu item represents an object that no longer exists .", - "context": ["view", "edit", "embed"], - "type": "boolean", - "readonly": true - }, - "menus": { - "description": "The terms assigned to the object in the nav_menu taxonomy.", - "type": "integer", - "context": ["view", "edit"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-menus", - "title": "The current user can assign terms in the nav_menu taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { - "type": "object", - "properties": { "menus": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-menus", - "title": "The current user can create terms in the nav_menu taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { - "type": "object", - "properties": { "menus": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/menu-item-object", - "title": "Get linked object.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items/{id}", - "targetSchema": { "type": "object", "properties": { "object": { "type": "integer" } } } - } - ] - }, - "nav_menu_item-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "nav_menu_item-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "GUID for the revision, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the object.", - "type": ["string", "object"], - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "wp_block": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_block", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_id": { + "context": [ + "edit", + "view" ], - "context": ["view", "edit"] + "default": 0, + "description": "User ID who owns the order. 0 for guests.", + "type": "integer" }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "wp_pattern_sync_status": { - "type": "string", - "description": "", - "default": "", - "enum": ["partial", "unsynced"] - }, - "footnotes": { "type": "string", "description": "", "default": "" } - } - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - }, - "wp_pattern_category": { - "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", - "type": "array", - "items": { "type": "integer" }, - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - }, - { - "rel": "https:/api.w.org/action-assign-wp_pattern_category", - "title": "The current user can assign terms in the wp_pattern_category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { - "type": "object", - "properties": { "wp_pattern_category": { "type": "array", "items": { "type": "integer" } } } - } - }, - { - "rel": "https:/api.w.org/action-create-wp_pattern_category", - "title": "The current user can create terms in the wp_pattern_category taxonomy.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", - "targetSchema": { - "type": "object", - "properties": { "wp_pattern_category": { "type": "array", "items": { "type": "integer" } } } - } - } - ] - }, - "wp_block-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_block-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "wp_pattern_sync_status": { - "type": "string", - "description": "", - "default": "", - "enum": ["partial", "unsynced"] - }, - "footnotes": { "type": "string", "description": "", "default": "" } - } - }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "wp_template": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_template", - "type": "object", - "properties": { - "id": { - "description": "ID of template.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "context": ["embed", "view", "edit"], - "required": true, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+" - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "type": { "description": "Type of template.", "type": "string", "context": ["embed", "view", "edit"] }, - "source": { - "description": "Source of template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "origin": { - "description": "Source of a customised template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "content": { - "description": "Content of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": ["edit"], - "readonly": true - } - } - }, - "title": { - "description": "Title of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "description": { - "description": "Description of template.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"] - }, - "status": { - "description": "Status of template.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_ip_address": { + "context": [ + "edit", + "view" ], - "default": "publish", - "context": ["embed", "view", "edit"] - }, - "wp_id": { - "description": "Post ID.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "has_theme_file": { - "description": "Theme file exists.", - "type": "bool", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the template was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "author_text": { - "type": "string", - "description": "Human readable text for the author.", + "description": "Customer's IP address.", "readonly": true, - "context": ["view", "edit", "embed"] + "type": "string" }, - "original_source": { - "description": "From where the template originally comes, eg 'theme'", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"], - "enum": ["theme", "plugin", "site", "user"] - }, - "is_custom": { - "description": "Whether a template is a custom template.", - "type": "bool", - "context": ["embed", "view", "edit"], - "readonly": true - } - } - }, - "wp_template_part": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_template_part", - "type": "object", - "properties": { - "id": { - "description": "ID of template.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "context": ["embed", "view", "edit"], - "required": true, - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+" - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "type": { "description": "Type of template.", "type": "string", "context": ["embed", "view", "edit"] }, - "source": { - "description": "Source of template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "origin": { - "description": "Source of a customised template", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "content": { - "description": "Content of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit"] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": ["edit"], - "readonly": true - } - } - }, - "title": { - "description": "Title of template.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "description": { - "description": "Description of template.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"] - }, - "status": { - "description": "Status of template.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_note": { + "context": [ + "edit", + "view" ], - "default": "publish", - "context": ["embed", "view", "edit"] + "description": "Note left by customer during checkout.", + "type": "string" }, - "wp_id": { - "description": "Post ID.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "has_theme_file": { - "description": "Theme file exists.", - "type": "bool", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "modified": { - "description": "The date the template was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "author_text": { - "type": "string", - "description": "Human readable text for the author.", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "original_source": { - "description": "From where the template originally comes, eg 'theme'", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"], - "enum": ["theme", "plugin", "site", "user"] - }, - "area": { - "description": "Where the template part is intended for use (header, footer, etc)", - "type": "string", - "context": ["embed", "view", "edit"] - } - } - }, - "wp_global_styles-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_global_styles-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "id": { - "description": "ID of global styles config.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "styles": { "description": "Global styles.", "type": ["object"], "context": ["view", "edit"] }, - "settings": { "description": "Global settings.", "type": ["object"], "context": ["view", "edit"] } - } - }, - "wp_global_styles": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_global_styles", - "type": "object", - "properties": { - "id": { - "description": "ID of global styles config.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "styles": { "description": "Global styles.", "type": ["object"], "context": ["view", "edit"] }, - "settings": { "description": "Global settings.", "type": ["object"], "context": ["view", "edit"] }, - "title": { - "description": "Title of the global styles variation.", - "type": ["object", "string"], - "default": "", - "context": ["embed", "view", "edit"], - "properties": { - "raw": { - "description": "Title for the global styles variation, as it exists in the database.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - } - } - }, - "wp_navigation": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_navigation", - "type": "object", - "properties": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], - "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "link": { - "description": "URL to the post.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "modified": { - "description": "The date the post was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "modified_gmt": { - "description": "The date the post was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "customer_user_agent": { + "context": [ + "edit", + "view" ], - "context": ["view", "edit", "embed"] - }, - "type": { - "description": "Type of post.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "context": ["edit"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "context": ["view", "edit"] - } - }, - "links": [ - { - "rel": "https:/api.w.org/action-publish", - "title": "The current user can publish this post.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", - "targetSchema": { - "type": "object", - "properties": { "status": { "type": "string", "enum": ["publish", "future"] } } - } - }, - { - "rel": "https:/api.w.org/action-unfiltered-html", - "title": "The current user can post unfiltered HTML markup and JavaScript.", - "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", - "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } - } - ] - }, - "wp_navigation-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_navigation-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], + "description": "User agent of the customer.", "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true + "type": "string" + }, + "date_completed": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was completed, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_completed_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was completed, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the order was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_paid": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was paid, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_paid_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the order was paid, as GMT.", + "readonly": true, + "type": "date-time" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total discount tax amount for the order.", + "readonly": true, + "type": "string" + }, + "discount_total": { + "context": [ + "edit", + "view" + ], + "description": "Total discount amount for the order.", + "readonly": true, + "type": "string" + }, + "fee_lines": { + "context": [ + "edit", + "view" + ], + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } + "type": "object" + }, + "type": "array" }, "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] + "is_editable": { + "context": [ + "edit", + "view" + ], + "description": "Whether an order can be edited.", + "readonly": true, + "type": "boolean" }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] + "line_items": { + "context": [ + "edit", + "view" + ], + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": "mixed" + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": "mixed" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] + "needs_payment": { + "context": [ + "edit", + "view" + ], + "description": "Whether an order needs payment, based on status and order total.", + "readonly": true, + "type": "boolean" }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], + "needs_processing": { + "context": [ + "edit", + "view" + ], + "description": "Whether an order needs processing before it can be completed.", + "readonly": true, + "type": "boolean" + }, + "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": [ + "edit", + "view" + ], + "description": "Payment method title.", + "type": "string" + }, + "payment_url": { + "context": [ + "edit", + "view" + ], + "description": "Order payment URL.", + "readonly": true, + "type": "string" + }, + "prices_include_tax": { + "context": [ + "edit", + "view" + ], + "description": "True the prices included tax during checkout.", + "readonly": true, + "type": "boolean" + }, + "refunds": { + "context": [ + "edit", + "view" + ], + "description": "List of refunds.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Refund ID.", + "readonly": true, + "type": "integer" + }, + "reason": { + "context": [ + "edit", + "view" + ], + "description": "Refund reason.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Refund total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "set_paid": { + "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": [ + "edit", + "view" + ], + "description": "Shipping address.", "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address line 1", + "type": "string" }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit", "embed"] + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Address line 2", + "type": "string" }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit", "embed"], - "readonly": true + "company": { + "context": [ + "edit", + "view" + ], + "description": "Company name.", + "type": "string" }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true - } - } - }, - "wp_font_family": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_font_family", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "theme_json_version": { - "description": "Version of the theme.json schema used for the typography settings.", - "type": "integer", - "default": 3, - "minimum": 2, - "maximum": 3, - "context": ["view", "edit", "embed"] - }, - "font_faces": { - "description": "The IDs of the child font faces in the font family.", - "type": "array", - "context": ["view", "edit", "embed"], - "items": { "type": "integer" } - }, - "font_family_settings": { - "description": "font-face definition in theme.json format.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "name": { "description": "Name of the font family preset, translatable.", "type": "string" }, - "slug": { "description": "Kebab-case unique identifier for the font family preset.", "type": "string" }, - "fontFamily": { "description": "CSS font-family value.", "type": "string" }, - "preview": { - "description": "URL to a preview image of the font family.", - "type": "string", - "format": "uri", - "default": "" + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" } }, - "required": ["name", "slug", "fontFamily"], - "additionalProperties": false - } - } - }, - "wp_font_face": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_font_face", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true + "type": "object" }, - "theme_json_version": { - "description": "Version of the theme.json schema used for the typography settings.", - "type": "integer", - "default": 3, - "minimum": 2, - "maximum": 3, - "context": ["view", "edit", "embed"] - }, - "parent": { - "description": "The ID for the parent font family of the font face.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "font_face_settings": { - "description": "font-face declaration in theme.json format.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "fontFamily": { "description": "CSS font-family value.", "type": "string", "default": "" }, - "fontStyle": { "description": "CSS font-style value.", "type": "string", "default": "normal" }, - "fontWeight": { - "description": "List of available font weights, separated by a space.", - "default": "400", - "type": ["string", "integer"] + "shipping_lines": { + "context": [ + "edit", + "view" + ], + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": "mixed" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } }, - "fontDisplay": { - "description": "CSS font-display value.", - "type": "string", - "default": "fallback", - "enum": ["auto", "block", "fallback", "swap", "optional"] - }, - "src": { - "description": "Paths or URLs to the font files.", - "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], - "default": [] - }, - "fontStretch": { "description": "CSS font-stretch value.", "type": "string" }, - "ascentOverride": { "description": "CSS ascent-override value.", "type": "string" }, - "descentOverride": { "description": "CSS descent-override value.", "type": "string" }, - "fontVariant": { "description": "CSS font-variant value.", "type": "string" }, - "fontFeatureSettings": { "description": "CSS font-feature-settings value.", "type": "string" }, - "fontVariationSettings": { "description": "CSS font-variation-settings value.", "type": "string" }, - "lineGapOverride": { "description": "CSS line-gap-override value.", "type": "string" }, - "sizeAdjust": { "description": "CSS size-adjust value.", "type": "string" }, - "unicodeRange": { "description": "CSS unicode-range value.", "type": "string" }, - "preview": { - "description": "URL to a preview image of the font face.", - "type": "string", - "format": "uri", - "default": "" - } + "type": "object" }, - "required": ["fontFamily", "src"], - "additionalProperties": false - } - } - }, - "product-revision": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "product-revision", - "type": "object", - "properties": { - "author": { - "description": "The ID for the author of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "type": "array" }, - "date": { - "description": "The date the revision was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the revision was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "guid": { - "description": "The globally unique identifier for the post.", - "type": "object", - "context": ["view", "edit"], + "shipping_tax": { + "context": [ + "edit", + "view" + ], + "description": "Total shipping tax amount for the order.", "readonly": true, - "properties": { - "raw": { - "description": "GUID for the post, as it exists in the database.", - "type": "string", - "context": ["edit"], - "readonly": true + "type": "string" + }, + "shipping_total": { + "context": [ + "edit", + "view" + ], + "description": "Total shipping amount for the order.", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "default": "pending", + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "type": "string" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Tax lines data.", + "items": { + "properties": { + "compound": { + "context": [ + "edit", + "view" + ], + "description": "Show if is a compound tax rate.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate label.", + "readonly": true, + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "rate_code": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate code.", + "readonly": true, + "type": "string" + }, + "rate_id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "shipping_tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax total.", + "readonly": true, + "type": "string" + }, + "tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total (not including shipping taxes).", + "readonly": true, + "type": "string" + } }, - "rendered": { - "description": "GUID for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - } - } + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Grand total.", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Sum of all taxes.", + "readonly": true, + "type": "string" + }, + "transaction_id": { + "context": [ + "edit", + "view" + ], + "description": "Unique transaction ID.", + "type": "string" + }, + "version": { + "context": [ + "edit", + "view" + ], + "description": "Version of WooCommerce which last updated the order.", + "readonly": true, + "type": "string" + } + }, + "title": "shop_order", + "type": "object" + }, + "shop_order_refund": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "amount": { + "context": [ + "edit", + "view" + ], + "description": "Refund amount.", + "type": "string" + }, + "api_refund": { + "context": [ + "edit" + ], + "default": true, + "description": "When true, the payment gateway API is used to generate the refund.", + "type": "boolean" + }, + "date_created": { + "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": [ + "edit", + "view" + ], + "description": "The date the order refund was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "fee_lines": { + "context": [ + "edit", + "view" + ], + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": "mixed" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" }, "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, - "modified": { - "description": "The date the revision was last modified, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "modified_gmt": { - "description": "The date the revision was last modified, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "slug": { - "description": "An alphanumeric identifier for the revision unique to its type.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The title for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": ["edit"] + "line_items": { + "context": [ + "edit", + "view" + ], + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Meta ID.", + "readonly": true, + "type": "integer" + }, + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "readonly": true, + "type": "mixed" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "mixed" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "mixed" + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "readonly": true, + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "readonly": true, + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "readonly": true, + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "readonly": true, + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "readonly": true, + "type": "integer" + } }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } + "type": "object" + }, + "readonly": true, + "type": "array" }, - "content": { - "description": "The content for the post.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": ["edit"], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } + "type": "object" + }, + "type": "array" }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true - } - } + "reason": { + "context": [ + "edit", + "view" + ], + "description": "Reason for refund.", + "type": "string" }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "preview_link": { - "description": "Preview link for the post.", - "type": "string", - "format": "uri", - "context": ["edit"], - "readonly": true + "refunded_by": { + "context": [ + "edit", + "view" + ], + "description": "User ID of user who created the refund.", + "type": "integer" + }, + "refunded_payment": { + "context": [ + "edit", + "view" + ], + "description": "If the payment was refunded via the API.", + "readonly": true, + "type": "boolean" + }, + "shipping_lines": { + "context": [ + "edit", + "view" + ], + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": "mixed" + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": "mixed" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tax_lines": { + "context": [ + "edit", + "view" + ], + "description": "Tax lines data.", + "items": { + "properties": { + "compound": { + "context": [ + "edit", + "view" + ], + "description": "Show if is a compound tax rate.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate label.", + "readonly": true, + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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": "mixed" + } + }, + "type": "object" + }, + "type": "array" + }, + "rate_code": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate code.", + "readonly": true, + "type": "string" + }, + "rate_id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "shipping_tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Shipping tax total.", + "readonly": true, + "type": "string" + }, + "tax_total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total (not including shipping taxes).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" } - } + }, + "title": "shop_order_refund", + "type": "object" }, - "type": { + "sidebar": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "type", - "type": "object", "properties": { - "capabilities": { - "description": "All capabilities used by the post type.", - "type": "object", - "context": ["edit"], - "readonly": true + "after_title": { + "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": [ + "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": [ + "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": [ + "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": [ + "edit", + "embed", + "view" + ], + "description": "Extra CSS class to assign to the sidebar in the Widgets interface.", + "readonly": true, + "type": "string" }, "description": { - "description": "A human-readable description of the post type.", - "type": "string", - "context": ["view", "edit"], - "readonly": true + "context": [ + "edit", + "embed", + "view" + ], + "description": "Description of sidebar.", + "readonly": true, + "type": "string" }, - "hierarchical": { - "description": "Whether or not the post type should have children.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true - }, - "viewable": { - "description": "Whether or not the post type can be viewed.", - "type": "boolean", - "context": ["edit"], - "readonly": true - }, - "labels": { - "description": "Human-readable labels for the post type for various contexts.", - "type": "object", - "context": ["edit"], - "readonly": true + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of sidebar.", + "readonly": true, + "type": "string" }, "name": { - "description": "The title for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "supports": { - "description": "All features, supported by the post type.", - "type": "object", - "context": ["edit"], - "readonly": true - }, - "has_archive": { - "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.", - "type": ["string", "boolean"], - "context": ["view", "edit"], - "readonly": true - }, - "taxonomies": { - "description": "Taxonomies associated with post type.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"], - "readonly": true - }, - "rest_base": { - "description": "REST base route for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "rest_namespace": { - "description": "REST route's namespace for the post type.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "visibility": { - "description": "The visibility settings for the post type.", - "type": "object", - "context": ["edit"], + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique name identifying the sidebar.", "readonly": true, - "properties": { - "show_ui": { - "description": "Whether to generate a default UI for managing this post type.", - "type": "boolean" - }, - "show_in_nav_menus": { - "description": "Whether to make the post type available for selection in navigation menus.", - "type": "boolean" - } - } + "type": "string" }, - "icon": { - "description": "The icon for the post type.", - "type": ["string", "null"], - "context": ["view", "edit", "embed"], - "readonly": true - }, - "template": { - "type": ["array"], - "description": "The block template associated with the post type.", + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Status of sidebar.", + "enum": [ + "active", + "inactive" + ], "readonly": true, - "context": ["view", "edit", "embed"] + "type": "string" }, - "template_lock": { - "type": ["string", "boolean"], - "enum": ["all", "insert", "contentOnly", false], - "description": "The template_lock associated with the post type, or false if none.", - "readonly": true, - "context": ["view", "edit", "embed"] + "widgets": { + "context": [ + "edit", + "embed", + "view" + ], + "default": [], + "description": "Nested widgets.", + "items": { + "type": [ + "object", + "string" + ] + }, + "type": "array" } - } + }, + "title": "sidebar", + "type": "object" }, "status": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "status", - "type": "object", "properties": { + "date_floating": { + "context": [ + "edit", + "view" + ], + "description": "Whether posts of this status may have floating published dates.", + "readonly": true, + "type": "boolean" + }, "name": { + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the status.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "readonly": true, + "type": "string" }, "private": { + "context": [ + "edit" + ], "description": "Whether posts with this status should be private.", - "type": "boolean", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "protected": { + "context": [ + "edit" + ], "description": "Whether posts with this status should be protected.", - "type": "boolean", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "public": { + "context": [ + "edit", + "view" + ], "description": "Whether posts of this status should be shown in the front end of the site.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "queryable": { + "context": [ + "edit", + "view" + ], "description": "Whether posts with this status should be publicly-queryable.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "show_in_list": { + "context": [ + "edit" + ], "description": "Whether to include posts in the edit listing for their post type.", - "type": "boolean", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "slug": { + "context": [ + "edit", + "embed", + "view" + ], "description": "An alphanumeric identifier for the status.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "date_floating": { - "description": "Whether posts of this status may have floating published dates.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "string" } - } + }, + "title": "status", + "type": "object" + }, + "system_status": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "active_plugins": { + "context": [ + "view" + ], + "description": "Active plugins.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "database": { + "context": [ + "view" + ], + "description": "Database.", + "properties": { + "database_prefix": { + "context": [ + "view" + ], + "description": "Database prefix.", + "readonly": true, + "type": "string" + }, + "database_tables": { + "context": [ + "view" + ], + "description": "Database tables.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "maxmind_geoip_database": { + "context": [ + "view" + ], + "description": "MaxMind GeoIP database.", + "readonly": true, + "type": "string" + }, + "wc_database_version": { + "context": [ + "view" + ], + "description": "WC database version.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "dropins_mu_plugins": { + "context": [ + "view" + ], + "description": "Dropins & MU plugins.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "environment": { + "context": [ + "view" + ], + "description": "Environment.", + "properties": { + "curl_version": { + "context": [ + "view" + ], + "description": "cURL version.", + "readonly": true, + "type": "string" + }, + "default_timezone": { + "context": [ + "view" + ], + "description": "Default timezone.", + "readonly": true, + "type": "string" + }, + "domdocument_enabled": { + "context": [ + "view" + ], + "description": "Is DomDocument class enabled?", + "readonly": true, + "type": "boolean" + }, + "fsockopen_or_curl_enabled": { + "context": [ + "view" + ], + "description": "Is fsockopen/cURL enabled?", + "readonly": true, + "type": "boolean" + }, + "gzip_enabled": { + "context": [ + "view" + ], + "description": "Is GZip enabled?", + "readonly": true, + "type": "boolean" + }, + "home_url": { + "context": [ + "view" + ], + "description": "Home URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "language": { + "context": [ + "view" + ], + "description": "WordPress language.", + "readonly": true, + "type": "string" + }, + "log_directory": { + "context": [ + "view" + ], + "description": "Log directory.", + "readonly": true, + "type": "string" + }, + "log_directory_writable": { + "context": [ + "view" + ], + "description": "Is log directory writable?", + "readonly": true, + "type": "boolean" + }, + "max_upload_size": { + "context": [ + "view" + ], + "description": "Max upload size.", + "readonly": true, + "type": "integer" + }, + "mbstring_enabled": { + "context": [ + "view" + ], + "description": "Is mbstring enabled?", + "readonly": true, + "type": "boolean" + }, + "mysql_version": { + "context": [ + "view" + ], + "description": "MySQL version.", + "readonly": true, + "type": "string" + }, + "mysql_version_string": { + "context": [ + "view" + ], + "description": "MySQL version string.", + "readonly": true, + "type": "string" + }, + "php_max_execution_time": { + "context": [ + "view" + ], + "description": "PHP max execution time.", + "readonly": true, + "type": "integer" + }, + "php_max_input_vars": { + "context": [ + "view" + ], + "description": "PHP max input vars.", + "readonly": true, + "type": "integer" + }, + "php_post_max_size": { + "context": [ + "view" + ], + "description": "PHP post max size.", + "readonly": true, + "type": "integer" + }, + "php_version": { + "context": [ + "view" + ], + "description": "PHP version.", + "readonly": true, + "type": "string" + }, + "remote_get_response": { + "context": [ + "view" + ], + "description": "Remote GET response.", + "readonly": true, + "type": "string" + }, + "remote_get_successful": { + "context": [ + "view" + ], + "description": "Remote GET successful?", + "readonly": true, + "type": "boolean" + }, + "remote_post_response": { + "context": [ + "view" + ], + "description": "Remote POST response.", + "readonly": true, + "type": "string" + }, + "remote_post_successful": { + "context": [ + "view" + ], + "description": "Remote POST successful?", + "readonly": true, + "type": "boolean" + }, + "server_info": { + "context": [ + "view" + ], + "description": "Server info.", + "readonly": true, + "type": "string" + }, + "site_url": { + "context": [ + "view" + ], + "description": "Site URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "soapclient_enabled": { + "context": [ + "view" + ], + "description": "Is SoapClient class enabled?", + "readonly": true, + "type": "boolean" + }, + "store_id": { + "context": [ + "view" + ], + "description": "WooCommerce Store Identifier.", + "readonly": true, + "type": "string" + }, + "suhosin_installed": { + "context": [ + "view" + ], + "description": "Is SUHOSIN installed?", + "readonly": true, + "type": "boolean" + }, + "version": { + "context": [ + "view" + ], + "description": "WooCommerce version.", + "readonly": true, + "type": "string" + }, + "wp_cron": { + "context": [ + "view" + ], + "description": "Are WordPress cron jobs enabled?", + "readonly": true, + "type": "boolean" + }, + "wp_debug_mode": { + "context": [ + "view" + ], + "description": "Is WordPress debug mode active?", + "readonly": true, + "type": "boolean" + }, + "wp_memory_limit": { + "context": [ + "view" + ], + "description": "WordPress memory limit.", + "readonly": true, + "type": "integer" + }, + "wp_multisite": { + "context": [ + "view" + ], + "description": "Is WordPress multisite?", + "readonly": true, + "type": "boolean" + }, + "wp_version": { + "context": [ + "view" + ], + "description": "WordPress version.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "inactive_plugins": { + "context": [ + "view" + ], + "description": "Inactive plugins.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "logging": { + "context": [ + "view" + ], + "description": "Logging.", + "properties": { + "default_handler": { + "context": [ + "view" + ], + "description": "The logging handler class.", + "readonly": true, + "type": "string" + }, + "level_threshold": { + "context": [ + "view" + ], + "description": "Minimum severity level.", + "readonly": true, + "type": "string" + }, + "log_directory_size": { + "context": [ + "view" + ], + "description": "The size of the log directory.", + "readonly": true, + "type": "string" + }, + "logging_enabled": { + "context": [ + "view" + ], + "description": "Is logging enabled?", + "readonly": true, + "type": "boolean" + }, + "retention_period_days": { + "context": [ + "view" + ], + "description": "The number of days log entries are retained.", + "readonly": true, + "type": "integer" + } + }, + "readonly": true, + "type": "object" + }, + "pages": { + "context": [ + "view" + ], + "description": "WooCommerce pages.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "post_type_counts": { + "context": [ + "view" + ], + "description": "Total post count.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "security": { + "context": [ + "view" + ], + "description": "Security.", + "properties": { + "hide_errors": { + "context": [ + "view" + ], + "description": "Hide errors from visitors?", + "readonly": true, + "type": "boolean" + }, + "secure_connection": { + "context": [ + "view" + ], + "description": "Is the connection to your store secure?", + "readonly": true, + "type": "boolean" + } + }, + "readonly": true, + "type": "object" + }, + "settings": { + "context": [ + "view" + ], + "description": "Settings.", + "properties": { + "HPOS_enabled": { + "context": [ + "view" + ], + "description": "Is HPOS enabled?", + "readonly": true, + "type": "boolean" + }, + "HPOS_sync_enabled": { + "context": [ + "view" + ], + "description": "Is HPOS sync enabled?", + "readonly": true, + "type": "boolean" + }, + "api_enabled": { + "context": [ + "view" + ], + "description": "Legacy REST API enabled?", + "readonly": true, + "type": "boolean" + }, + "currency": { + "context": [ + "view" + ], + "description": "Currency.", + "readonly": true, + "type": "string" + }, + "currency_position": { + "context": [ + "view" + ], + "description": "Currency position.", + "readonly": true, + "type": "string" + }, + "currency_symbol": { + "context": [ + "view" + ], + "description": "Currency symbol.", + "readonly": true, + "type": "string" + }, + "decimal_separator": { + "context": [ + "view" + ], + "description": "Decimal separator.", + "readonly": true, + "type": "string" + }, + "enforce_approved_download_dirs": { + "context": [ + "view" + ], + "description": "Enforce approved download directories?", + "readonly": true, + "type": "boolean" + }, + "force_ssl": { + "context": [ + "view" + ], + "description": "SSL forced?", + "readonly": true, + "type": "boolean" + }, + "geolocation_enabled": { + "context": [ + "view" + ], + "description": "Geolocation enabled?", + "readonly": true, + "type": "boolean" + }, + "number_of_decimals": { + "context": [ + "view" + ], + "description": "Number of decimals.", + "readonly": true, + "type": "integer" + }, + "order_datastore": { + "context": [ + "view" + ], + "description": "Order datastore.", + "readonly": true, + "type": "string" + }, + "product_visibility_terms": { + "context": [ + "view" + ], + "description": "Terms in the product visibility taxonomy.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "taxonomies": { + "context": [ + "view" + ], + "description": "Taxonomy terms for product/order statuses.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "thousand_separator": { + "context": [ + "view" + ], + "description": "Thousand separator.", + "readonly": true, + "type": "string" + }, + "wccom_connected": { + "context": [ + "view" + ], + "description": "Is store connected to WooCommerce.com?", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "theme": { + "context": [ + "view" + ], + "description": "Theme.", + "properties": { + "author_url": { + "context": [ + "view" + ], + "description": "Theme author URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "has_outdated_templates": { + "context": [ + "view" + ], + "description": "Does this theme have outdated templates?", + "readonly": true, + "type": "boolean" + }, + "has_woocommerce_file": { + "context": [ + "view" + ], + "description": "Does the theme have a woocommerce.php file?", + "readonly": true, + "type": "boolean" + }, + "has_woocommerce_support": { + "context": [ + "view" + ], + "description": "Does the theme declare WooCommerce support?", + "readonly": true, + "type": "boolean" + }, + "is_child_theme": { + "context": [ + "view" + ], + "description": "Is this theme a child theme?", + "readonly": true, + "type": "boolean" + }, + "name": { + "context": [ + "view" + ], + "description": "Theme name.", + "readonly": true, + "type": "string" + }, + "overrides": { + "context": [ + "view" + ], + "description": "Template overrides.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "parent_author_url": { + "context": [ + "view" + ], + "description": "Parent theme author URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "parent_name": { + "context": [ + "view" + ], + "description": "Parent theme name.", + "readonly": true, + "type": "string" + }, + "parent_version": { + "context": [ + "view" + ], + "description": "Parent theme version.", + "readonly": true, + "type": "string" + }, + "version": { + "context": [ + "view" + ], + "description": "Theme version.", + "readonly": true, + "type": "string" + }, + "version_latest": { + "context": [ + "view" + ], + "description": "Latest version of theme.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "system_status", + "type": "object" + }, + "system_status_tool": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "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" + }, + "tag": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "post_tag" + ], + "readonly": true, + "type": "string" + } + }, + "title": "tag", + "type": "object" + }, + "tax": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "city": { + "context": [ + "edit", + "view" + ], + "description": "City name.", + "type": "string" + }, + "class": { + "context": [ + "edit", + "view" + ], + "default": "standard", + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "type": "string" + }, + "compound": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "Whether or not this is a compound rate.", + "type": "boolean" + }, + "country": { + "context": [ + "edit", + "view" + ], + "description": "Country ISO 3166 code.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate name.", + "type": "string" + }, + "order": { + "context": [ + "edit", + "view" + ], + "description": "Indicates the order that will appear in queries.", + "type": "integer" + }, + "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": [ + "edit", + "view" + ], + "default": true, + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State code.", + "type": "string" + } + }, + "title": "tax", + "type": "object" + }, + "tax_class": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "name": { + "context": [ + "edit", + "view" + ], + "description": "Tax class name.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "string" + } + }, + "title": "tax_class", + "type": "object" }, "taxonomy": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "taxonomy", - "type": "object", "properties": { "capabilities": { + "context": [ + "edit" + ], "description": "All capabilities used by the taxonomy.", - "type": "object", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "object" }, "description": { + "context": [ + "edit", + "view" + ], "description": "A human-readable description of the taxonomy.", - "type": "string", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "string" }, "hierarchical": { + "context": [ + "edit", + "view" + ], "description": "Whether or not the taxonomy should have children.", - "type": "boolean", - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "boolean" }, "labels": { + "context": [ + "edit" + ], "description": "Human-readable labels for the taxonomy for various contexts.", - "type": "object", - "context": ["edit"], - "readonly": true + "readonly": true, + "type": "object" }, "name": { + "context": [ + "edit", + "embed", + "view" + ], "description": "The title for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "slug": { - "description": "An alphanumeric identifier for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "show_cloud": { - "description": "Whether or not the term cloud should be displayed.", - "type": "boolean", - "context": ["edit"], - "readonly": true - }, - "types": { - "description": "Types associated with the taxonomy.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"], - "readonly": true + "readonly": true, + "type": "string" }, "rest_base": { + "context": [ + "edit", + "embed", + "view" + ], "description": "REST base route for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "readonly": true, + "type": "string" }, "rest_namespace": { + "context": [ + "edit", + "embed", + "view" + ], "description": "REST namespace route for the taxonomy.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "readonly": true, + "type": "string" + }, + "show_cloud": { + "context": [ + "edit" + ], + "description": "Whether or not the term cloud should be displayed.", + "readonly": true, + "type": "boolean" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the taxonomy.", + "readonly": true, + "type": "string" + }, + "types": { + "context": [ + "edit", + "view" + ], + "description": "Types associated with the taxonomy.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" }, "visibility": { + "context": [ + "edit" + ], "description": "The visibility settings for the taxonomy.", - "type": "object", - "context": ["edit"], - "readonly": true, "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" }, - "show_ui": { - "description": "Whether to generate a default UI for managing this taxonomy.", + "publicly_queryable": { + "description": "Whether the taxonomy is publicly queryable.", "type": "boolean" }, "show_admin_column": { @@ -13657,11986 +21878,4310 @@ "show_in_quick_edit": { "description": "Whether to show the taxonomy in the Quick/Bulk edit panel.", "type": "boolean" + }, + "show_ui": { + "description": "Whether to generate a default UI for managing this taxonomy.", + "type": "boolean" } - } - } - } - }, - "category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "category", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["category"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "parent": { "description": "The parent term ID.", "type": "integer", "context": ["view", "edit"] }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "tag": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "tag", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["post_tag"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "nav_menu": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "nav_menu", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] }, - "locations": { - "description": "The locations assigned to the menu.", - "type": "array", - "items": { "type": "string" }, - "context": ["view", "edit"] - }, - "auto_add": { - "description": "Whether to automatically add top-level pages to this menu.", - "context": ["view", "edit"], - "type": "boolean" - } - } - }, - "wp_pattern_category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp_pattern_category", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "count": { - "description": "Number of published posts for the term.", - "type": "integer", - "context": ["view", "edit"], - "readonly": true - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "context": ["view", "edit"] - }, - "link": { - "description": "URL of the term.", - "type": "string", - "format": "uri", - "context": ["view", "embed", "edit"], - "readonly": true - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "context": ["view", "embed", "edit"], - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "context": ["view", "embed", "edit"] - }, - "taxonomy": { - "description": "Type attribution for the term.", - "type": "string", - "enum": ["wp_pattern_category"], - "context": ["view", "embed", "edit"], - "readonly": true - }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "user": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "user", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the user.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "username": { - "description": "Login name for the user.", - "type": "string", - "context": ["edit"], - "required": true - }, - "name": { - "description": "Display name for the user.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "first_name": { "description": "First name for the user.", "type": "string", "context": ["edit"] }, - "last_name": { "description": "Last name for the user.", "type": "string", "context": ["edit"] }, - "email": { - "description": "The email address for the user.", - "type": "string", - "format": "email", - "context": ["edit"], - "required": true - }, - "url": { - "description": "URL of the user.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "description": { - "description": "Description of the user.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "link": { - "description": "Author URL of the user.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "locale": { - "description": "Locale for the user.", - "type": "string", - "enum": ["", "en_US", "en_GB", "fr_BE", "fr_FR"], - "context": ["edit"] - }, - "nickname": { "description": "The nickname for the user.", "type": "string", "context": ["edit"] }, - "slug": { - "description": "An alphanumeric identifier for the user.", - "type": "string", - "context": ["embed", "view", "edit"] - }, - "registered_date": { - "description": "Registration date for the user.", - "type": "string", - "format": "date-time", - "context": ["edit"], - "readonly": true - }, - "roles": { - "description": "Roles assigned to the user.", - "type": "array", - "items": { "type": "string" }, - "context": ["edit"] - }, - "password": { - "description": "Password for the user (never included).", - "type": "string", - "context": [], - "required": true - }, - "capabilities": { - "description": "All capabilities assigned to the user.", - "type": "object", - "context": ["edit"], - "readonly": true - }, - "extra_capabilities": { - "description": "Any extra capabilities assigned to the user.", - "type": "object", - "context": ["edit"], - "readonly": true - }, - "avatar_urls": { - "description": "Avatar URLs for the user.", - "type": "object", - "context": ["embed", "view", "edit"], + }, "readonly": true, - "properties": { - "24": { - "description": "Avatar URL with image size of 24 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "48": { - "description": "Avatar URL with image size of 48 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "96": { - "description": "Avatar URL with image size of 96 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - } - } - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "context": ["view", "edit"], - "properties": { - "persisted_preferences": { - "type": "object", - "description": "", - "default": [], - "context": ["edit"], - "properties": { - "_modified": { - "description": "The date and time the preferences were updated.", - "type": "string", - "format": "date-time", - "readonly": false - } - }, - "additionalProperties": true - }, - "woocommerce_launch_your_store_tour_hidden": { - "type": "string", - "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", - "default": "" - }, - "woocommerce_coming_soon_banner_dismissed": { - "type": "string", - "description": "Indicate whether the user has dismissed the coming soon notice or not.", - "default": "" - } - } + "type": "object" } - } + }, + "title": "taxonomy", + "type": "object" }, - "application-password": { + "term": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "application-password", - "type": "object", "properties": { - "uuid": { - "description": "The unique identifier for the application password.", - "type": "string", - "format": "uuid", - "context": ["view", "edit", "embed"], - "readonly": true + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of objects (posts of any type) assigned to the term.", + "readonly": true, + "type": "integer" }, - "app_id": { - "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", - "format": "uuid", - "context": ["view", "edit", "embed"] + "description": { + "context": [ + "edit", + "view" + ], + "description": "Term description.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" }, "name": { - "description": "The name of the application password.", - "type": "string", - "required": true, - "context": ["view", "edit", "embed"], - "minLength": 1, - "pattern": ".*\\S.*" - }, - "password": { - "description": "The generated password. Only available after adding an application.", - "type": "string", - "context": ["edit"], - "readonly": true - }, - "created": { - "description": "The GMT date the application password was created.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "last_used": { - "description": "The GMT date the application password was last used.", - "type": ["string", "null"], - "format": "date-time", - "context": ["view", "edit"], - "readonly": true - }, - "last_ip": { - "description": "The IP address the application password was last used by.", - "type": ["string", "null"], - "format": "ip", - "context": ["view", "edit"], - "readonly": true - } - } - }, - "comment": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "comment", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the comment.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "author": { - "description": "The ID of the user object, if author was a user.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "author_email": { - "description": "Email address for the comment author.", - "type": "string", - "format": "email", - "context": ["edit"] - }, - "author_ip": { - "description": "IP address for the comment author.", - "type": "string", - "format": "ip", - "context": ["edit"] - }, - "author_name": { - "description": "Display name for the comment author.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "author_url": { - "description": "URL for the comment author.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"] - }, - "author_user_agent": { - "description": "User agent for the comment author.", - "type": "string", - "context": ["edit"] - }, - "content": { - "description": "The content for the comment.", - "type": "object", - "context": ["view", "edit", "embed"], - "properties": { - "raw": { - "description": "Content for the comment, as it exists in the database.", - "type": "string", - "context": ["edit"] - }, - "rendered": { - "description": "HTML content for the comment, transformed for display.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - } - } - }, - "date": { - "description": "The date the comment was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "context": ["view", "edit", "embed"] - }, - "date_gmt": { - "description": "The date the comment was published, as GMT.", - "type": "string", - "format": "date-time", - "context": ["view", "edit"] - }, - "link": { - "description": "URL to the comment.", - "type": "string", - "format": "uri", - "context": ["view", "edit", "embed"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "Term name.", + "readonly": true, + "type": "string" }, "parent": { - "description": "The ID for the parent of the comment.", - "type": "integer", - "context": ["view", "edit", "embed"], - "default": 0 - }, - "post": { - "description": "The ID of the associated post object.", - "type": "integer", - "context": ["view", "edit"], - "default": 0 - }, - "status": { "description": "State of the comment.", "type": "string", "context": ["view", "edit"] }, - "type": { - "description": "Type of the comment.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "author_avatar_urls": { - "description": "Avatar URLs for the comment author.", - "type": "object", - "context": ["view", "edit", "embed"], + "context": [ + "edit", + "view" + ], + "description": "Parent term ID, if applicable.", "readonly": true, - "properties": { - "24": { - "description": "Avatar URL with image size of 24 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "48": { - "description": "Avatar URL with image size of 48 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - }, - "96": { - "description": "Avatar URL with image size of 96 pixels.", - "type": "string", - "format": "uri", - "context": ["embed", "view", "edit"] - } - } + "type": "integer" }, - "meta": { "description": "Meta fields.", "type": "object", "context": ["view", "edit"], "properties": [] } - } - }, - "search-result": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "search-result", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier for the object.", - "type": ["integer", "string"], - "context": ["view", "embed"], - "readonly": true - }, - "title": { - "description": "The title for the object.", - "type": "string", - "context": ["view", "embed"], - "readonly": true - }, - "url": { - "description": "URL to the object.", - "type": "string", - "format": "uri", - "context": ["view", "embed"], - "readonly": true - }, - "type": { - "description": "Object type.", - "type": "string", - "enum": ["post", "term", "post-format"], - "context": ["view", "embed"], - "readonly": true - }, - "subtype": { - "description": "Object subtype.", - "type": "string", - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag"], - "context": ["view", "embed"], - "readonly": true - } - } - }, - "rendered-block": { - "$schema": "http:/json-schema.org/schema#", - "title": "rendered-block", - "type": "object", - "properties": { - "rendered": { "description": "The rendered block.", "type": "string", "required": true, "context": ["edit"] } - } - }, - "block-type": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-type", - "type": "object", - "properties": { - "api_version": { - "description": "Version of block API.", - "type": "integer", - "default": 1, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "title": { - "description": "Title of block type.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "name": { - "description": "Unique name identifying the block type.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "description": { - "description": "Description of block type.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "icon": { - "description": "Icon of block type.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "attributes": { - "description": "Block attributes.", - "type": ["object", "null"], - "properties": [], - "default": null, - "additionalProperties": { "type": "object" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "provides_context": { - "description": "Context provided by blocks of this type.", - "type": "object", - "properties": [], - "additionalProperties": { "type": "string" }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "uses_context": { - "description": "Context values inherited by blocks of this type.", - "type": "array", - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "selectors": { - "description": "Custom CSS selectors.", - "type": "object", - "default": [], - "properties": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "supports": { - "description": "Block supports.", - "type": "object", - "default": [], - "properties": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "category": { - "description": "Block category.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "is_dynamic": { - "description": "Is the block dynamically rendered.", - "type": "boolean", - "default": false, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_script_handles": { - "description": "Editor script handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "script_handles": { - "description": "Public facing and editor script handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_script_handles": { - "description": "Public facing script handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_script_module_ids": { - "description": "Public-facing script module IDs.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_style_handles": { - "description": "Editor style handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "style_handles": { - "description": "Public facing and editor style handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_style_handles": { - "description": "Public-facing style handles.", - "type": ["array"], - "default": [], - "items": { "type": "string" }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "styles": { - "description": "Block style variations.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { "description": "Unique name identifying the style.", "type": "string", "required": true }, - "label": { "description": "The human-readable label for the style.", "type": "string" }, - "inline_style": { - "description": "Inline CSS code that registers the CSS class required for the style.", - "type": "string" - }, - "style_handle": { "description": "Contains the handle that defines the block style.", "type": "string" } - } - }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "variations": { - "description": "Block variations.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { "description": "The unique and machine-readable name.", "type": "string", "required": true }, - "title": { "description": "A human-readable variation title.", "type": "string", "required": true }, - "description": { - "description": "A detailed variation description.", - "type": "string", - "required": false - }, - "category": { - "description": "Block category.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "icon": { - "description": "Icon of block type.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "isDefault": { - "description": "Indicates whether the current variation is the default one.", - "type": "boolean", - "required": false, - "default": false - }, - "attributes": { "description": "The initial values for attributes.", "type": "object" }, - "innerBlocks": { - "description": "The list of inner blocks used in the example.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the inner block.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true - }, - "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" - } - } - } - }, - "example": { - "description": "Block example.", - "type": ["object", "null"], - "default": null, - "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, - "innerBlocks": { - "description": "The list of inner blocks used in the example.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the inner block.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true - }, - "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" - } - } - } - } - }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "scope": { - "description": "The list of scopes where the variation is applicable. When not provided, it assumes all available scopes.", - "type": ["array", "null"], - "default": null, - "items": { "type": "string", "enum": ["block", "inserter", "transform"] }, - "readonly": true - }, - "keywords": { - "description": "Block keywords.", - "type": "array", - "items": { "type": "string" }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - } - } - }, + "slug": { + "context": [ + "edit", + "view" + ], + "description": "String based identifier for the term.", "readonly": true, - "context": ["embed", "view", "edit"], - "default": null - }, - "textdomain": { - "description": "Public text domain.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "parent": { - "description": "Parent blocks.", - "type": ["array", "null"], - "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$" }, - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "ancestor": { - "description": "Ancestor blocks.", - "type": ["array", "null"], - "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$" }, - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "allowed_blocks": { - "description": "Allowed child block types.", - "type": ["array", "null"], - "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$" }, - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "keywords": { - "description": "Block keywords.", - "type": "array", - "items": { "type": "string" }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "example": { - "description": "Block example.", - "type": ["object", "null"], - "default": null, - "properties": { - "attributes": { "description": "The attributes used in the example.", "type": "object" }, - "innerBlocks": { - "description": "The list of inner blocks used in the example.", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "description": "The name of the inner block.", - "type": "string", - "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", - "required": true - }, - "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" - } - } - } - } - }, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "block_hooks": { - "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.", - "type": "object", - "patternProperties": { - "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$": { - "type": "string", - "enum": ["before", "after", "first_child", "last_child"] - } - }, - "default": [], - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_script": { - "description": "Editor script handle. DEPRECATED: Use `editor_script_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "script": { - "description": "Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "view_script": { - "description": "Public facing script handle. DEPRECATED: Use `view_script_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "editor_style": { - "description": "Editor style handle. DEPRECATED: Use `editor_style_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true - }, - "style": { - "description": "Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.", - "type": ["string", "null"], - "default": null, - "context": ["embed", "view", "edit"], - "readonly": true + "type": "string" } - } - }, - "settings": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "settings", - "type": "object", - "properties": { - "title": { "type": "string", "title": "Title", "description": "Site title.", "default": null }, - "description": { "type": "string", "title": "Tagline", "description": "Site tagline.", "default": null }, - "url": { "type": "string", "title": "", "description": "Site URL.", "default": null, "format": "uri" }, - "email": { - "type": "string", - "title": "", - "description": "This address is used for admin purposes, like new user notification.", - "default": null, - "format": "email" - }, - "timezone": { - "type": "string", - "title": "", - "description": "A city in the same timezone as you.", - "default": null - }, - "date_format": { - "type": "string", - "title": "", - "description": "A date format for all date strings.", - "default": null - }, - "time_format": { - "type": "string", - "title": "", - "description": "A time format for all time strings.", - "default": null - }, - "start_of_week": { - "type": "integer", - "title": "", - "description": "A day number of the week that the week should start on.", - "default": null - }, - "language": { "type": "string", "title": "", "description": "WordPress locale code.", "default": "en_US" }, - "use_smilies": { - "type": "boolean", - "title": "", - "description": "Convert emoticons like :-) and :-P to graphics on display.", - "default": true - }, - "default_category": { - "type": "integer", - "title": "", - "description": "Default post category.", - "default": null - }, - "default_post_format": { - "type": "string", - "title": "", - "description": "Default post format.", - "default": null - }, - "posts_per_page": { - "type": "integer", - "title": "Maximum posts per page", - "description": "Blog pages show at most.", - "default": 10 - }, - "show_on_front": { - "type": "string", - "title": "Show on front", - "description": "What to show on the front page", - "default": null - }, - "page_on_front": { - "type": "integer", - "title": "Page on front", - "description": "The ID of the page that should be displayed on the front page", - "default": null - }, - "page_for_posts": { - "type": "integer", - "title": "", - "description": "The ID of the page that should display the latest posts", - "default": null - }, - "default_ping_status": { - "type": "string", - "title": "", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", - "default": null, - "enum": ["open", "closed"] - }, - "default_comment_status": { - "type": "string", - "title": "Allow comments on new posts", - "description": "Allow people to submit comments on new posts.", - "default": null, - "enum": ["open", "closed"] - }, - "site_logo": { "type": "integer", "title": "Logo", "description": "Site logo.", "default": null }, - "site_icon": { "type": "integer", "title": "Icon", "description": "Site icon.", "default": null }, - "pickup_location_settings": { - "type": "object", - "title": "", - "description": "WooCommerce Local Pickup Method Settings", - "default": [], - "properties": { - "enabled": { - "description": "If enabled, this method will appear on the block based checkout.", - "type": "string", - "enum": ["yes", "no"] - }, - "title": { - "description": "This controls the title which the user sees during checkout.", - "type": "string" - }, - "tax_status": { - "description": "If a cost is defined, this controls if taxes are applied to that cost.", - "type": "string", - "enum": ["taxable", "none"] - }, - "cost": { "description": "Optional cost to charge for local pickup.", "type": "string" } - }, - "additionalProperties": false - }, - "pickup_locations": { - "type": "array", - "title": "", - "description": "WooCommerce Local Pickup Locations", - "default": [], - "items": { - "type": "object", - "properties": { - "name": { "type": "string" }, - "address": { - "type": "object", - "properties": { - "address_1": { "type": "string" }, - "city": { "type": "string" }, - "state": { "type": "string" }, - "postcode": { "type": "string" }, - "country": { "type": "string" } - }, - "additionalProperties": false - }, - "details": { "type": "string" }, - "enabled": { "type": "boolean" } - }, - "additionalProperties": false - } - } - } + }, + "title": "term", + "type": "object" }, "theme": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "theme", - "type": "object", "properties": { - "stylesheet": { - "description": "The theme's style sheet. This uniquely identifies the theme.", - "type": "string", - "readonly": true - }, - "stylesheet_uri": { - "description": "The URI for the theme's style sheet directory.", - "type": "string", - "format": "uri", - "readonly": true - }, - "template": { - "description": "The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet.", - "type": "string", - "readonly": true - }, - "template_uri": { - "description": "The URI for the theme's template directory. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet directory.", - "type": "string", - "format": "uri", - "readonly": true - }, "author": { "description": "The theme author.", - "type": "object", - "readonly": true, "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" }, "author_uri": { "description": "The website of the theme author.", - "type": "object", - "readonly": true, "properties": { "raw": { "description": "The website of the theme author, as found in the theme header.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" }, "rendered": { "description": "The website of the theme author, transformed for display.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" } - } + }, + "readonly": true, + "type": "object" }, "description": { "description": "A description of the theme.", - "type": "object", - "readonly": true, "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" }, "is_block_theme": { "description": "Whether the theme is a block-based theme.", - "type": "boolean", - "readonly": true + "readonly": true, + "type": "boolean" }, "name": { "description": "The name of the theme.", - "type": "object", - "readonly": true, "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" }, "requires_php": { "description": "The minimum PHP version required for the theme to work.", - "type": "string", - "readonly": true + "readonly": true, + "type": "string" }, "requires_wp": { "description": "The minimum WordPress version required for the theme to work.", - "type": "string", - "readonly": true + "readonly": true, + "type": "string" }, "screenshot": { "description": "The theme's screenshot URL.", - "type": "string", "format": "uri", - "readonly": true + "readonly": true, + "type": "string" + }, + "status": { + "description": "A named status for the theme.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "stylesheet": { + "description": "The theme's style sheet. This uniquely identifies the theme.", + "readonly": true, + "type": "string" + }, + "stylesheet_uri": { + "description": "The URI for the theme's style sheet directory.", + "format": "uri", + "readonly": true, + "type": "string" }, "tags": { "description": "Tags indicating styles and features of the theme.", - "type": "object", - "readonly": true, "properties": { "raw": { "description": "The theme tags, as found in the theme header.", - "type": "array", - "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" + }, + "template": { + "description": "The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet.", + "readonly": true, + "type": "string" + }, + "template_uri": { + "description": "The URI for the theme's template directory. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's style sheet directory.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "textdomain": { + "description": "The theme's text domain.", + "readonly": true, + "type": "string" }, - "textdomain": { "description": "The theme's text domain.", "type": "string", "readonly": true }, "theme_supports": { "description": "Features supported by this theme.", - "type": "object", - "readonly": true, "properties": { "align-wide": { + "default": false, "description": "Whether theme opts in to wide alignment CSS class.", - "type": "boolean", - "default": false + "type": "boolean" }, "automatic-feed-links": { + "default": false, "description": "Whether posts and comments RSS feed links are added to head.", - "type": "boolean", - "default": false - }, - "block-templates": { - "description": "Whether a theme uses block-based templates.", - "type": "boolean", - "default": false + "type": "boolean" }, "block-template-parts": { + "default": false, "description": "Whether a theme uses block-based template parts.", - "type": "boolean", - "default": false + "type": "boolean" + }, + "block-templates": { + "default": false, + "description": "Whether a theme uses block-based templates.", + "type": "boolean" }, "custom-background": { - "description": "Custom background if defined by the theme.", - "type": ["boolean", "object"], + "additionalProperties": false, "default": false, + "description": "Custom background if defined by the theme.", "properties": { - "default-image": { "type": "string", "format": "uri" }, - "default-preset": { "type": "string", "enum": ["default", "fill", "fit", "repeat", "custom"] }, - "default-position-x": { "type": "string", "enum": ["left", "center", "right"] }, - "default-position-y": { "type": "string", "enum": ["left", "center", "right"] }, - "default-size": { "type": "string", "enum": ["auto", "contain", "cover"] }, - "default-repeat": { "type": "string", "enum": ["repeat-x", "repeat-y", "repeat", "no-repeat"] }, - "default-attachment": { "type": "string", "enum": ["scroll", "fixed"] }, - "default-color": { "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" + } }, - "additionalProperties": false + "type": [ + "boolean", + "object" + ] }, "custom-header": { - "description": "Custom header if defined by the theme.", - "type": ["boolean", "object"], + "additionalProperties": false, "default": false, + "description": "Custom header if defined by the theme.", "properties": { - "default-image": { "type": "string", "format": "uri" }, - "random-default": { "type": "boolean" }, - "width": { "type": "integer" }, - "height": { "type": "integer" }, - "flex-height": { "type": "boolean" }, - "flex-width": { "type": "boolean" }, - "default-text-color": { "type": "string" }, - "header-text": { "type": "boolean" }, - "uploads": { "type": "boolean" }, - "video": { "type": "boolean" } + "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" + } }, - "additionalProperties": false + "type": [ + "boolean", + "object" + ] }, "custom-logo": { - "description": "Custom logo if defined by the theme.", - "type": ["boolean", "object"], + "additionalProperties": false, "default": false, + "description": "Custom logo if defined by the theme.", "properties": { - "width": { "type": "integer" }, - "height": { "type": "integer" }, - "flex-width": { "type": "boolean" }, - "flex-height": { "type": "boolean" }, - "header-text": { "type": "array", "items": { "type": "string" } }, - "unlink-homepage-logo": { "type": "boolean" } + "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" + } }, - "additionalProperties": false + "type": [ + "boolean", + "object" + ] }, "customize-selective-refresh-widgets": { + "default": false, "description": "Whether the theme enables Selective Refresh for Widgets being managed with the Customizer.", - "type": "boolean", - "default": false + "type": "boolean" }, "dark-editor-style": { + "default": false, "description": "Whether theme opts in to the dark editor style UI.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-custom-colors": { + "default": false, "description": "Whether the theme disables custom colors.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-custom-font-sizes": { + "default": false, "description": "Whether the theme disables custom font sizes.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-custom-gradients": { + "default": false, "description": "Whether the theme disables custom gradients.", - "type": "boolean", - "default": false + "type": "boolean" }, "disable-layout-styles": { + "default": false, "description": "Whether the theme disables generated layout styles.", - "type": "boolean", - "default": false + "type": "boolean" }, "editor-color-palette": { - "description": "Custom color palette if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom color palette if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "slug": { "type": "string" }, - "color": { "type": "string" } + "color": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-font-sizes": { - "description": "Custom font sizes if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom font sizes if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "number" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "number" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-gradient-presets": { - "description": "Custom gradient presets if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom gradient presets if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "gradient": { "type": "string" }, - "slug": { "type": "string" } + "gradient": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-spacing-sizes": { - "description": "Custom spacing sizes if defined by the theme.", - "type": ["boolean", "array"], "default": false, + "description": "Custom spacing sizes if defined by the theme.", "items": { - "type": "object", + "additionalProperties": false, "properties": { - "name": { "type": "string" }, - "size": { "type": "string" }, - "slug": { "type": "string" } + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "slug": { + "type": "string" + } }, - "additionalProperties": false - } + "type": "object" + }, + "type": [ + "array", + "boolean" + ] }, "editor-styles": { - "description": "Whether theme opts in to the editor styles CSS wrapper.", - "type": "boolean", - "default": false - }, - "html5": { - "description": "Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.", - "type": ["boolean", "array"], "default": false, - "items": { - "type": "string", - "enum": ["search-form", "comment-form", "comment-list", "gallery", "caption", "script", "style"] - } + "description": "Whether theme opts in to the editor styles CSS wrapper.", + "type": "boolean" }, "formats": { + "default": [ + "standard" + ], "description": "Post formats supported.", - "type": "array", - "default": ["standard"], "items": { - "type": "string", "enum": { - "standard": "standard", "aside": "aside", + "audio": "audio", "chat": "chat", "gallery": "gallery", - "link": "link", "image": "image", + "link": "link", "quote": "quote", + "standard": "standard", "status": "status", - "video": "video", - "audio": "audio" - } - } + "video": "video" + }, + "type": "string" + }, + "type": "array" + }, + "html5": { + "default": false, + "description": "Allows use of HTML5 markup for search forms, comment forms, comment lists, gallery, and caption.", + "items": { + "enum": [ + "caption", + "comment-form", + "comment-list", + "gallery", + "script", + "search-form", + "style" + ], + "type": "string" + }, + "type": [ + "array", + "boolean" + ] }, "post-thumbnails": { - "description": "The post types that support thumbnails or true if all post types are supported.", - "type": ["boolean", "array"], "default": false, - "items": { "type": "string" } + "description": "The post types that support thumbnails or true if all post types are supported.", + "items": { + "type": "string" + }, + "type": [ + "array", + "boolean" + ] }, "responsive-embeds": { + "default": false, "description": "Whether the theme supports responsive embedded content.", - "type": "boolean", - "default": false + "type": "boolean" }, "title-tag": { + "default": false, "description": "Whether the theme can manage the document title tag.", - "type": "boolean", - "default": false + "type": "boolean" }, "wp-block-styles": { + "default": false, "description": "Whether theme opts in to default WordPress block styles for viewing.", - "type": "boolean", - "default": false + "type": "boolean" } - } + }, + "readonly": true, + "type": "object" }, "theme_uri": { "description": "The URI of the theme's webpage.", - "type": "object", - "readonly": true, "properties": { "raw": { "description": "The URI of the theme's webpage, as found in the theme header.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" }, "rendered": { "description": "The URI of the theme's webpage, transformed for display.", - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" } - } - }, - "version": { "description": "The theme's current version.", "type": "string", "readonly": true }, - "status": { "description": "A named status for the theme.", "type": "string", "enum": ["inactive", "active"] } - } - }, - "plugin": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "plugin", - "type": "object", - "properties": { - "plugin": { - "description": "The plugin file.", - "type": "string", - "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", + }, "readonly": true, - "context": ["view", "edit", "embed"] - }, - "status": { - "description": "The plugin activation status.", - "type": "string", - "enum": ["inactive", "active"], - "context": ["view", "edit", "embed"] - }, - "name": { - "description": "The plugin name.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "plugin_uri": { - "description": "The plugin's website address.", - "type": "string", - "format": "uri", - "readonly": true, - "context": ["view", "edit"] - }, - "author": { - "description": "The plugin author.", - "type": "object", - "readonly": true, - "context": ["view", "edit"] - }, - "author_uri": { - "description": "The plugin author's website address.", - "type": "string", - "format": "uri", - "readonly": true, - "context": ["view", "edit"] - }, - "description": { - "description": "The plugin description.", - "type": "object", - "readonly": true, - "context": ["view", "edit"], - "properties": { - "raw": { "description": "The raw plugin description.", "type": "string" }, - "rendered": { "description": "The plugin description formatted for display.", "type": "string" } - } + "type": "object" }, "version": { - "description": "The plugin version number.", - "type": "string", + "description": "The theme's current version.", "readonly": true, - "context": ["view", "edit"] - }, - "network_only": { - "description": "Whether the plugin can only be activated network wide.", - "type": "boolean", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "requires_wp": { - "description": "Minimum required version of WordPress.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "requires_php": { - "description": "Minimum required version of PHP.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "textdomain": { - "description": "The plugin's text domain.", - "type": "string", - "readonly": true, - "context": ["view", "edit"] + "type": "string" } - } + }, + "title": "theme", + "type": "object" }, - "sidebar": { + "top_sellers_report": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "sidebar", - "type": "object", "properties": { - "id": { - "description": "ID of sidebar.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, "name": { - "description": "Unique name identifying the sidebar.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "context": [ + "view" + ], + "description": "Product name.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "view" + ], + "description": "Product ID.", + "readonly": true, + "type": "integer" + }, + "quantity": { + "context": [ + "view" + ], + "description": "Total number of purchases.", + "readonly": true, + "type": "integer" + } + }, + "title": "top_sellers_report", + "type": "object" + }, + "type": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "capabilities": { + "context": [ + "edit" + ], + "description": "All capabilities used by the post type.", + "readonly": true, + "type": "object" }, "description": { - "description": "Description of sidebar.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "A human-readable description of the post type.", + "readonly": true, + "type": "string" }, - "class": { - "description": "Extra CSS class to assign to the sidebar in the Widgets interface.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "has_archive": { + "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": [ + "boolean", + "string" + ] }, - "before_widget": { - "description": "HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "hierarchical": { + "context": [ + "edit", + "view" + ], + "description": "Whether or not the post type should have children.", + "readonly": true, + "type": "boolean" }, - "after_widget": { - "description": "HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "icon": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The icon for the post type.", + "readonly": true, + "type": [ + "null", + "string" + ] }, - "before_title": { - "description": "HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "labels": { + "context": [ + "edit" + ], + "description": "Human-readable labels for the post type for various contexts.", + "readonly": true, + "type": "object" }, - "after_title": { - "description": "HTML content to append to the sidebar title when displayed. Default is a closing h2 element.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post type.", + "readonly": true, + "type": "string" + }, + "rest_base": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "REST base route for the post type.", + "readonly": true, + "type": "string" + }, + "rest_namespace": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "REST route's namespace for the post type.", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post type.", + "readonly": true, + "type": "string" + }, + "supports": { + "context": [ + "edit" + ], + "description": "All features, supported by the post type.", + "readonly": true, + "type": "object" + }, + "taxonomies": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomies associated with post type.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "template": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The block template associated with the post type.", + "readonly": true, + "type": [ + "array" + ] + }, + "template_lock": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The template_lock associated with the post type, or false if none.", + "enum": [ + "all", + "insert", + "contentOnly", + false + ], + "readonly": true, + "type": [ + "boolean", + "string" + ] + }, + "viewable": { + "context": [ + "edit" + ], + "description": "Whether or not the post type can be viewed.", + "readonly": true, + "type": "boolean" + }, + "visibility": { + "context": [ + "edit" + ], + "description": "The visibility settings for the post type.", + "properties": { + "show_in_nav_menus": { + "description": "Whether to make the post type available for selection in navigation menus.", + "type": "boolean" + }, + "show_ui": { + "description": "Whether to generate a default UI for managing this post type.", + "type": "boolean" + } + }, + "readonly": true, + "type": "object" + } + }, + "title": "type", + "type": "object" + }, + "upload_theme": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "message": { + "context": [ + "edit", + "view" + ], + "description": "Theme installation message.", + "readonly": true, + "type": "string" }, "status": { - "description": "Status of sidebar.", - "type": "string", - "enum": ["active", "inactive"], - "context": ["embed", "view", "edit"], - "readonly": true + "context": [ + "edit", + "view" + ], + "description": "Theme installation status.", + "readonly": true, + "type": "string" }, - "widgets": { - "description": "Nested widgets.", - "type": "array", - "items": { "type": ["object", "string"] }, - "default": [], - "context": ["embed", "view", "edit"] + "theme": { + "context": [ + "edit", + "view" + ], + "description": "Uploaded theme.", + "readonly": true, + "type": "object" } - } + }, + "title": "upload_theme", + "type": "object" }, - "widget-type": { + "user": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "widget-type", - "type": "object", "properties": { - "id": { - "description": "Unique slug identifying the widget type.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true + "avatar_urls": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URLs for the user.", + "properties": { + "24": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 24 pixels.", + "format": "uri", + "type": "string" + }, + "48": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 48 pixels.", + "format": "uri", + "type": "string" + }, + "96": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Avatar URL with image size of 96 pixels.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" }, - "name": { - "description": "Human-readable name identifying the widget type.", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "capabilities": { + "context": [ + "edit" + ], + "description": "All capabilities assigned to the user.", + "readonly": true, + "type": "object" }, "description": { - "description": "Description of the widget.", - "type": "string", - "default": "", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "embed", + "view" + ], + "description": "Description of the user.", + "type": "string" }, - "is_multi": { - "description": "Whether the widget supports multiple instances", - "type": "boolean", - "context": ["view", "edit", "embed"], - "readonly": true + "email": { + "context": [ + "edit" + ], + "description": "The email address for the user.", + "format": "email", + "required": true, + "type": "string" }, - "classname": { - "description": "Class name", - "type": "string", - "default": "", - "context": ["embed", "view", "edit"], - "readonly": true + "extra_capabilities": { + "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" + }, + "id": { + "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" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Author URL of the user.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "locale": { + "context": [ + "edit" + ], + "description": "Locale for the user.", + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "persisted_preferences": { + "additionalProperties": true, + "context": [ + "edit" + ], + "default": [], + "description": "", + "properties": { + "_modified": { + "description": "The date and time the preferences were updated.", + "format": "date-time", + "readonly": false, + "type": "string" + } + }, + "type": "object" + }, + "woocommerce_coming_soon_banner_dismissed": { + "default": "", + "description": "Indicate whether the user has dismissed the coming soon notice or not.", + "type": "string" + }, + "woocommerce_launch_your_store_tour_hidden": { + "default": "", + "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Display name 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).", + "required": true, + "type": "string" + }, + "registered_date": { + "context": [ + "edit" + ], + "description": "Registration date for the user.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "roles": { + "context": [ + "edit" + ], + "description": "Roles assigned to the user.", + "items": { + "type": "string" + }, + "type": "array" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "url": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the user.", + "format": "uri", + "type": "string" + }, + "username": { + "context": [ + "edit" + ], + "description": "Login name for the user.", + "required": true, + "type": "string" } - } + }, + "title": "user", + "type": "object" + }, + "webhook": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the webhook was created, in the site's timezone.", + "readonly": true, + "type": "date-time" + }, + "date_created_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the webhook was created, as GMT.", + "readonly": true, + "type": "date-time" + }, + "date_modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the webhook was last modified, as GMT.", + "readonly": true, + "type": "date-time" + }, + "delivery_url": { + "context": [ + "edit", + "view" + ], + "description": "The URL where the webhook payload is delivered.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "event": { + "context": [ + "edit", + "view" + ], + "description": "Webhook event.", + "readonly": true, + "type": "string" + }, + "hooks": { + "context": [ + "edit", + "view" + ], + "description": "WooCommerce action names associated with the webhook.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "A friendly name for the webhook.", + "type": "string" + }, + "resource": { + "context": [ + "edit", + "view" + ], + "description": "Webhook resource.", + "readonly": true, + "type": "string" + }, + "secret": { + "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": [ + "edit", + "view" + ], + "default": "active", + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "type": "string" + }, + "topic": { + "context": [ + "edit", + "view" + ], + "description": "Webhook topic.", + "type": "string" + } + }, + "title": "webhook", + "type": "object" + }, + "webhook_delivery": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "date_created": { + "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": [ + "edit", + "view" + ], + "description": "The date the webhook delivery was logged, as GMT.", + "readonly": true, + "type": "date-time" + }, + "duration": { + "context": [ + "view" + ], + "description": "The delivery duration, in seconds.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "view" + ], + "description": "Unique identifier for the resource.", + "readonly": true, + "type": "integer" + }, + "request_body": { + "context": [ + "view" + ], + "description": "Request body", + "readonly": true, + "type": "string" + }, + "request_headers": { + "context": [ + "view" + ], + "description": "Request headers", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "request_url": { + "context": [ + "view" + ], + "description": "The URL where the webhook was delivered.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "response_body": { + "context": [ + "view" + ], + "description": "The response body from the receiving server.", + "readonly": true, + "type": "string" + }, + "response_code": { + "context": [ + "view" + ], + "description": "The HTTP response code from the receiving server.", + "readonly": true, + "type": "string" + }, + "response_headers": { + "context": [ + "view" + ], + "description": "Array of the response headers from the receiving server.", + "items": { + "type": "string" + }, + "readonly": true, + "type": "array" + }, + "response_message": { + "context": [ + "view" + ], + "description": "The HTTP response message from the receiving server.", + "readonly": true, + "type": "string" + }, + "summary": { + "context": [ + "view" + ], + "description": "A friendly summary of the response including the HTTP response code, message, and body.", + "readonly": true, + "type": "string" + } + }, + "title": "webhook_delivery", + "type": "object" }, "widget": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "widget", - "type": "object", "properties": { + "form_data": { + "context": [], + "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": { + "context": [ + "edit", + "embed", + "view" + ], "description": "Unique identifier for the widget.", - "type": "string", - "context": ["view", "edit", "embed"] + "type": "string" }, "id_base": { + "context": [ + "edit", + "embed", + "view" + ], "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "sidebar": { - "description": "The sidebar to which the widget belongs.", - "type": "string", - "default": "wp_inactive_widgets", - "required": true, - "context": ["view", "edit", "embed"] - }, - "rendered": { - "description": "HTML representation of the widget.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true - }, - "rendered_form": { - "description": "HTML representation of the widget admin form.", - "type": "string", - "context": ["edit"], - "readonly": true + "type": "string" }, "instance": { - "description": "Instance settings of the widget, if supported.", - "type": "object", - "context": ["edit"], + "context": [ + "edit" + ], "default": null, + "description": "Instance settings of the widget, if supported.", "properties": { "encoded": { + "context": [ + "edit" + ], "description": "Base64 encoded representation of the instance settings.", - "type": "string", - "context": ["edit"] + "type": "string" }, "hash": { + "context": [ + "edit" + ], "description": "Cryptographic hash of the instance settings.", - "type": "string", - "context": ["edit"] + "type": "string" }, "raw": { + "context": [ + "edit" + ], "description": "Unencoded instance settings, if supported.", - "type": "object", - "context": ["edit"] + "type": "object" } - } + }, + "type": "object" }, - "form_data": { - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", - "type": "string", - "context": [] + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML representation of the widget.", + "readonly": true, + "type": "string" + }, + "rendered_form": { + "context": [ + "edit" + ], + "description": "HTML representation of the widget admin form.", + "readonly": true, + "type": "string" + }, + "sidebar": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "wp_inactive_widgets", + "description": "The sidebar to which the widget belongs.", + "required": true, + "type": "string" } - } + }, + "title": "widget", + "type": "object" }, - "block-directory-item": { + "widget-type": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-directory-item", - "type": "object", "properties": { - "name": { - "description": "The block name, in namespace/block-name format.", - "type": "string", - "context": ["view"] - }, - "title": { - "description": "The block title, in human readable format.", - "type": "string", - "context": ["view"] + "classname": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Class name", + "readonly": true, + "type": "string" }, "description": { - "description": "A short description of the block, in human readable format.", - "type": "string", - "context": ["view"] + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of the widget.", + "type": "string" }, - "id": { "description": "The block slug.", "type": "string", "context": ["view"] }, - "rating": { "description": "The star rating of the block.", "type": "number", "context": ["view"] }, - "rating_count": { "description": "The number of ratings.", "type": "integer", "context": ["view"] }, - "active_installs": { - "description": "The number of sites that have activated this block.", - "type": "integer", - "context": ["view"] - }, - "author_block_rating": { - "description": "The average rating of blocks published by the same author.", - "type": "number", - "context": ["view"] - }, - "author_block_count": { - "description": "The number of blocks published by the same author.", - "type": "integer", - "context": ["view"] - }, - "author": { - "description": "The WordPress.org username of the block author.", - "type": "string", - "context": ["view"] - }, - "icon": { "description": "The block icon.", "type": "string", "format": "uri", "context": ["view"] }, - "last_updated": { - "description": "The date when the block was last updated.", - "type": "string", - "format": "date-time", - "context": ["view"] - }, - "humanized_updated": { - "description": "The date when the block was last updated, in fuzzy human readable format.", - "type": "string", - "context": ["view"] - } - } - }, - "pattern-directory-item": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "pattern-directory-item", - "type": "object", - "properties": { "id": { - "description": "The pattern ID.", - "type": "integer", - "minimum": 1, - "context": ["view", "edit", "embed"] - }, - "title": { - "description": "The pattern title, in human readable format.", - "type": "string", - "minLength": 1, - "context": ["view", "edit", "embed"] - }, - "content": { - "description": "The pattern content.", - "type": "string", - "minLength": 1, - "context": ["view", "edit", "embed"] - }, - "categories": { - "description": "The pattern's category slugs.", - "type": "array", - "uniqueItems": true, - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "keywords": { - "description": "The pattern's keywords.", - "type": "array", - "uniqueItems": true, - "items": { "type": "string" }, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "A description of the pattern.", - "type": "string", - "minLength": 1, - "context": ["view", "edit", "embed"] - }, - "viewport_width": { - "description": "The preferred width of the viewport when previewing a pattern, in pixels.", - "type": "integer", - "context": ["view", "edit", "embed"] - }, - "block_types": { - "description": "The block types which can use this pattern.", - "type": "array", - "uniqueItems": true, - "items": { "type": "string" }, - "context": ["view", "embed"] - } - } - }, - "block-pattern": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-pattern", - "type": "object", - "properties": { - "name": { - "description": "The pattern name.", - "type": "string", + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique slug identifying the widget type.", "readonly": true, - "context": ["view", "edit", "embed"] + "type": "string" }, - "title": { - "description": "The pattern title, in human readable format.", - "type": "string", + "is_multi": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the widget supports multiple instances", "readonly": true, - "context": ["view", "edit", "embed"] - }, - "content": { - "description": "The pattern content.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The pattern detailed description.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "viewport_width": { - "description": "The pattern viewport width for inserter preview.", - "type": "number", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "inserter": { - "description": "Determines whether the pattern is visible in inserter.", - "type": "boolean", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "categories": { - "description": "The pattern's category slugs.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "keywords": { - "description": "The pattern keywords.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "block_types": { - "description": "Block types that the pattern is intended to be used with.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "post_types": { - "description": "An array of post types that the pattern is restricted to be used with.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "template_types": { - "description": "An array of template types where the pattern fits.", - "type": "array", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "source": { - "description": "Where the pattern comes from e.g. core", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"], - "enum": [ - "core", - "plugin", - "theme", - "pattern-directory/core", - "pattern-directory/theme", - "pattern-directory/featured" - ] - } - } - }, - "block-pattern-category": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "block-pattern-category", - "type": "object", - "properties": { - "name": { - "description": "The category name.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "label": { - "description": "The category label, in human readable format.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The category description in a human-readable format.", - "type": "string", - "readonly": true, - "context": ["view", "edit", "embed"] - } - } - }, - "menu-location": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "menu-location", - "type": "object", - "properties": { - "name": { - "description": "The name of the menu location.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "description": { - "description": "The description of the menu location.", - "type": "string", - "context": ["embed", "view", "edit"], - "readonly": true - }, - "menu": { - "description": "The ID of the assigned menu.", - "type": "integer", - "context": ["embed", "view", "edit"], - "readonly": true - } - } - }, - "font-collection": { - "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "font-collection", - "type": "object", - "properties": { - "slug": { - "description": "Unique identifier for the font collection.", - "type": "string", - "context": ["view", "edit", "embed"], - "readonly": true + "type": "boolean" }, "name": { - "description": "The name for the font collection.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "description": { - "description": "The description for the font collection.", - "type": "string", - "context": ["view", "edit", "embed"] - }, - "font_families": { - "description": "The font families for the font collection.", - "type": "array", - "context": ["view", "edit", "embed"] - }, - "categories": { - "description": "The categories for the font collection.", - "type": "array", - "context": ["view", "edit", "embed"] + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Human-readable name identifying the widget type.", + "readonly": true, + "type": "string" } - } + }, + "title": "widget-type", + "type": "object" }, "wp-site-health-test": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "wp-site-health-test", - "type": "object", "properties": { - "test": { "type": "string", "description": "The name of the test being run.", "readonly": true }, - "label": { "type": "string", "description": "A label describing the test.", "readonly": true }, - "status": { - "type": "string", - "description": "The status of the test.", - "enum": ["good", "recommended", "critical"], - "readonly": true + "actions": { + "description": "HTML containing an action to direct the user to where they can resolve the issue.", + "readonly": true, + "type": "string" }, "badge": { - "type": "object", "description": "The category this test is grouped in.", "properties": { - "label": { "type": "string", "readonly": true }, "color": { - "type": "string", - "enum": ["blue", "orange", "red", "green", "purple", "gray"], - "readonly": true + "enum": [ + "blue", + "gray", + "green", + "orange", + "purple", + "red" + ], + "readonly": true, + "type": "string" + }, + "label": { + "readonly": true, + "type": "string" } }, - "readonly": true + "readonly": true, + "type": "object" }, "description": { - "type": "string", "description": "A more descriptive explanation of what the test looks for, and why it is important for the user.", - "readonly": true + "readonly": true, + "type": "string" }, - "actions": { - "type": "string", - "description": "HTML containing an action to direct the user to where they can resolve the issue.", - "readonly": true + "label": { + "description": "A label describing the test.", + "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" }, - "navigation-fallback": { + "wp_block": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "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" + } + }, + "type": "object" + }, + "title": "The current user can assign terms in the wp_pattern_category taxonomy." + }, + { + "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" + } + }, + "type": "object" + }, + "title": "The current user can create terms in the wp_pattern_category taxonomy." + } + ], + "properties": { + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, + "wp_pattern_sync_status": { + "default": "", + "description": "", + "enum": [ + "partial", + "unsynced" + ], + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + }, + "wp_pattern_category": { + "context": [ + "edit", + "view" + ], + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "wp_block", + "type": "object" + }, + "wp_block-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "excerpt": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, + "wp_pattern_sync_status": { + "default": "", + "description": "", + "enum": [ + "partial", + "unsynced" + ], + "type": "string" + } + }, + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + } + }, + "type": "object" + } + }, + "title": "wp_block-revision", + "type": "object" + }, + "wp_font_face": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "font_face_settings": { + "additionalProperties": false, + "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" + }, + "fontDisplay": { + "default": "fallback", + "description": "CSS font-display value.", + "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" + }, + "fontWeight": { + "default": "400", + "description": "List of available font weights, separated by a space.", + "type": [ + "integer", + "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" + }, + "src": { + "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" + } + }, + "required": [ + "fontFamily", + "src" + ], + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent font family of the font face.", + "type": "integer" + }, + "theme_json_version": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 3, + "description": "Version of the theme.json schema used for the typography settings.", + "maximum": 3, + "minimum": 2, + "type": "integer" + } + }, + "title": "wp_font_face", + "type": "object" + }, + "wp_font_family": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "font_faces": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The IDs of the child font faces in the font family.", + "items": { + "type": "integer" + }, + "type": "array" + }, + "font_family_settings": { + "additionalProperties": false, + "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" + }, + "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" + } + }, + "required": [ + "fontFamily", + "name", + "slug" + ], + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "theme_json_version": { + "context": [ + "edit", + "embed", + "view" + ], + "default": 3, + "description": "Version of the theme.json schema used for the typography settings.", + "maximum": 3, + "minimum": 2, + "type": "integer" + } + }, + "title": "wp_font_family", + "type": "object" + }, + "wp_global_styles": { "$schema": "http:/json-schema.org/draft-04/schema#", - "title": "navigation-fallback", - "type": "object", "properties": { "id": { - "description": "The unique identifier for the Navigation Menu.", - "type": "integer", - "context": ["view", "edit", "embed"], - "readonly": true + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of global styles config.", + "readonly": true, + "type": "string" + }, + "settings": { + "context": [ + "edit", + "view" + ], + "description": "Global settings.", + "type": [ + "object" + ] + }, + "styles": { + "context": [ + "edit", + "view" + ], + "description": "Global styles.", + "type": [ + "object" + ] + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of the global styles variation.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the global styles variation, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] } - } + }, + "title": "wp_global_styles", + "type": "object" + }, + "wp_global_styles-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of global styles config.", + "readonly": true, + "type": "string" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "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" + }, + "wp_navigation": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "links": [ + { + "href": "https:/haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation/{id}", + "rel": "https:/api.w.org/action-publish", + "targetSchema": { + "properties": { + "status": { + "enum": [ + "future", + "publish" + ], + "type": "string" + } + }, + "type": "object" + }, + "title": "The current user can publish this post." + }, + { + "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" + }, + "title": "The current user can post unfiltered HTML markup and JavaScript." + } + ], + "properties": { + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit", + "embed" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "context": [ + "edit", + "view" + ], + "description": "The date the post was published, as GMT.", + "format": "date-time", + "type": [ + "null", + "string" + ] + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the post.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL to the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the post was last modified, as GMT.", + "format": "date-time", + "readonly": true, + "type": "string" + }, + "password": { + "context": [ + "edit" + ], + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the post unique to its type.", + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "template": { + "context": [ + "edit", + "view" + ], + "description": "The theme file to use to display the post.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of post.", + "readonly": true, + "type": "string" + } + }, + "title": "wp_navigation", + "type": "object" + }, + "wp_navigation-revision": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the revision.", + "type": "integer" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit", + "embed" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "date": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was published, as GMT.", + "format": "date-time", + "type": "string" + }, + "guid": { + "context": [ + "edit", + "view" + ], + "description": "The globally unique identifier for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "GUID for the post, as it exists in the database.", + "readonly": true, + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "GUID for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the revision.", + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "modified": { + "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": [ + "edit", + "view" + ], + "description": "The date the revision was last modified, as GMT.", + "format": "date-time", + "type": "string" + }, + "parent": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the parent of the revision.", + "type": "integer" + }, + "preview_link": { + "context": [ + "edit" + ], + "description": "Preview link for the post.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the revision unique to its type.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "title": "wp_navigation-revision", + "type": "object" + }, + "wp_pattern_category": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "count": { + "context": [ + "edit", + "view" + ], + "description": "Number of published posts for the term.", + "readonly": true, + "type": "integer" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "HTML description of the term.", + "type": "string" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique identifier for the term.", + "readonly": true, + "type": "integer" + }, + "link": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "URL of the term.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Meta fields.", + "properties": [], + "type": "object" + }, + "name": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type attribution for the term.", + "enum": [ + "wp_pattern_category" + ], + "readonly": true, + "type": "string" + } + }, + "title": "wp_pattern_category", + "type": "object" + }, + "wp_template": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the template.", + "type": "integer" + }, + "author_text": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Human readable text for the author.", + "readonly": true, + "type": "string" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of template.", + "type": "string" + }, + "has_theme_file": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme file exists.", + "readonly": true, + "type": "bool" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of template.", + "readonly": true, + "type": "string" + }, + "is_custom": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether a template is a custom template.", + "readonly": true, + "type": "bool" + }, + "modified": { + "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": [ + "edit", + "embed", + "view" + ], + "description": "Source of a customised template", + "readonly": true, + "type": "string" + }, + "original_source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "From where the template originally comes, eg 'theme'", + "enum": [ + "plugin", + "site", + "theme", + "user" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": true, + "type": "string" + }, + "source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Source of template", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "publish", + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "theme": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" + }, + "wp_id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Post ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "wp_template", + "type": "object" + }, + "wp_template_part": { + "$schema": "http:/json-schema.org/draft-04/schema#", + "properties": { + "area": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Where the template part is intended for use (header, footer, etc)", + "type": "string" + }, + "author": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "The ID for the author of the template.", + "type": "integer" + }, + "author_text": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Human readable text for the author.", + "readonly": true, + "type": "string" + }, + "content": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "description": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Description of template.", + "type": "string" + }, + "has_theme_file": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme file exists.", + "readonly": true, + "type": "bool" + }, + "id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "ID of template.", + "readonly": true, + "type": "string" + }, + "modified": { + "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": [ + "edit", + "embed", + "view" + ], + "description": "Source of a customised template", + "readonly": true, + "type": "string" + }, + "original_source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "From where the template originally comes, eg 'theme'", + "enum": [ + "plugin", + "site", + "theme", + "user" + ], + "readonly": true, + "type": "string" + }, + "slug": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": true, + "type": "string" + }, + "source": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Source of template", + "readonly": true, + "type": "string" + }, + "status": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "publish", + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "theme": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Theme identifier for the template.", + "type": "string" + }, + "title": { + "context": [ + "edit", + "embed", + "view" + ], + "default": "", + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "type": [ + "object", + "string" + ] + }, + "type": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Type of template.", + "type": "string" + }, + "wp_id": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Post ID.", + "readonly": true, + "type": "integer" + } + }, + "title": "wp_template_part", + "type": "object" } } }, + "info": { + "contact": { + "email": "contact@gcch.fr", + "name": "Haiku Atelier", + "url": "https:/haikuatelier.fr.ddev.site" + }, + "description": "", + "title": "Haiku Atelier API", + "version": "6.6.1" + }, + "openapi": "3.1.0", "paths": { - "/wc/v3": { + "/carbon-fields/v1": { "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/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/connect": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_key": { "type": "string", "required": true } }, - "required": ["product_key"] - } - } - } - } - } - }, - "/wc/v3/marketplace/subscriptions/disconnect": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_key": { "type": "string", "required": true } }, - "required": ["product_key"] - } - } - } - } - } - }, - "/wc/v3/marketplace/subscriptions/activate": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_key": { "type": "string", "required": true } }, - "required": ["product_key"] - } - } - } - } - } - }, - "/wc/v3/marketplace/subscriptions/install-url": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "product_key", "in": "query", "description": "", "required": true, "schema": {} }] - } - }, - "/wc/v3/marketplace/create-order": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "product_id": { "required": true } }, - "required": ["product_id"] - } - } - } - } - } - }, - "/wc/v3/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, "parameters": [ { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "code", - "in": "query", - "description": "Limit result set to resources with a specific code.", "required": false, "schema": {} } - ] - }, - "post": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["code"] - } - } + "description": "OK" } } } }, - "/wc/v3/coupons/{id}": { + "/carbon-fields/v1/association": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } + "description": "OK" } } } }, - "/wc/v3/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/customers/{customer_id}/downloads": { + "/carbon-fields/v1/association/options": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } } + "description": "OK" } - }, - "parameters": [ - { - "name": "customer_id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] + } } }, - "/wc/v3/customers": { + "/carbon-fields/v1/attachment": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, "parameters": [ { - "name": "context", + "description": "The requested type: ID or URL.", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } - }, - { - "name": "email", - "in": "query", - "description": "Limit result set to resources with a specific email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "role", - "in": "query", - "description": "Limit result set to resources with a specific role.", - "required": false, - "schema": { - "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "required": true, "description": "New user email address." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "required": false, "description": "New user username." }, - "password": { "type": "string", "required": true, "description": "New user password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["email", "password"] - } - } - } - } - } - }, - "/wc/v3/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - }, - "reassign": { "type": "integer", "description": "ID to reassign posts to." } - } - } - } - } - } - } - }, - "/wc/v3/customers/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/layout-templates": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "area", - "in": "query", - "description": "Area to get templates for.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/v3/layout-templates/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/v3/orders/{order_id}/notes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { "name": "type", + "required": true, + "schema": {} + }, + { + "description": "The ID / URL of the attachment", "in": "query", - "description": "Limit result to customers or internal notes.", - "required": false, - "schema": { "enum": ["any", "customer", "internal"] } + "name": "value", + "required": true, + "schema": {} } - ] - }, + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/block-renderer": { "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "note": { "type": "string", "required": true, "description": "Order note content." }, - "customer_note": { - "type": "boolean", - "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." - }, - "added_by_user": { - "type": "boolean", - "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system." - } - }, - "required": ["note"] - } - } - } - } - } - }, - "/wc/v3/orders/{order_id}/notes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/orders/{order_id}/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "amount": { "type": "string", "description": "Refund amount." }, - "reason": { "type": "string", "description": "Reason for refund." }, - "refunded_by": { "type": "integer", "description": "User ID of user who created the refund." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "api_refund": { - "type": "boolean", - "description": "When true, the payment gateway API is used to generate the refund." - }, - "api_restock": { "type": "boolean", "description": "When true, refunded items are restocked." } - } - } - } - } - } - } - }, - "/wc/v3/orders/{order_id}/refunds/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders which have specific statuses.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": [ - "any", - "trash", - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ] - } - } - }, - { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - } - }, - "/wc/v3/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - } - }, - "/wc/v3/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products/custom-fields/names": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": {} - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort items ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - } - ] - } - }, - "/wc/v3/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to reviews published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } - }, - { - "name": "reviewer", - "in": "query", - "description": "Limit result set to reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_exclude", - "in": "query", - "description": "Ensure result set excludes reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_email", - "in": "query", - "description": "Limit result set to that from a specific author email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to reviews assigned to specific product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to reviews assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", + "content": { + "description": "The content of the block.", "required": true, - "description": "Unique identifier for the product." + "type": "string" }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "reviewer_email": { "type": "string", "required": true, "description": "Email of the reviewer." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "name": { + "description": "The name of the block.", + "required": true, + "type": "string" + }, + "post_id": { + "description": "ID of the post context.", + "type": "integer" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"] + "required": [ + "content", + "name" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } } } }, - "/wc/v3/products/reviews/{id}": { + "/carbon-fields/v1/comments/{id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/carbon-fields/v1/options": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/products/reviews/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products/shipping_classes/slug-suggestion": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { "name": "name", "in": "query", "description": "Shipping class name.", "required": false, "schema": {} }, - { - "name": "slug", - "in": "query", - "description": "An alphanumeric identifier for the resource unique to its type.", - "required": false, - "schema": {} - }, - { - "name": "description", - "in": "query", - "description": "HTML description of the resource.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/v3/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/products/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/products/tags/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v3/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order", - "price", - "popularity", - "rating" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "search_sku", - "in": "query", - "description": "Limit results to those with a SKU that partially matches a string.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/suggested-products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "in_stock", - "in": "query", - "description": "Limit result set to products in stock or out of stock.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result set to specific product categorie ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tags", - "in": "query", - "description": "Limit result set to specific product tag ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "limit", - "in": "query", - "description": "Limit result set to specific amount of suggested products.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/v3/products/{id}/duplicate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "has_price", - "in": "query", - "description": "Limit result set to products with or without price.", - "required": false, - "schema": {} - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with specified attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { "type": "string", "description": "Attribute slug." }, - "term": { "type": "string", "description": "Attribute term." }, - "terms": { "type": "array", "description": "Attribute terms." } - } - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/products/{product_id}/variations/generate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "delete": { "type": "boolean", "description": "Deletes unused variations." }, - "default_values": { "type": "object", "description": "Default values for generated variations." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v3/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc/v3/reports/sales": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v3/reports/top_sellers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v3/reports/orders/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_order_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/products/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_product_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/customers/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customer_total" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/coupons/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupon_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports/reviews/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_review_total" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/reports": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/settings": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } } - } - } - } - }, - "/wc/v3/settings/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - } - } - }, - "/wc/v3/settings/{group_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/v3/settings/{group_id}/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - } - }, - "/wc/v3/settings/{group_id}/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } - } - } - } - }, - "/wc/v3/shipping/zones": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } + "description": "OK" } } }, "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - }, - "required": ["name"] - } - } + "description": "OK" } } } }, - "/wc/v3/shipping/zones/{id}": { + "/carbon-fields/v1/posts/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/shipping/zones/{id}/locations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } - } - } - } - }, - "/wc/v3/shipping/zones/{zone_id}/methods": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." }, - "method_id": { "required": true, "description": "Shipping method ID." } - }, - "required": ["method_id"] - } - } - } - } - } - }, - "/wc/v3/shipping/zones/{zone_id}/methods/{instance_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, { - "name": "instance_id", + "description": "", "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v3/taxes/classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "name": { "type": "string", "required": true, "description": "Tax class name." } }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v3/taxes/classes/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "order", "priority"] } - }, - { - "name": "class", - "in": "query", - "description": "Sort by tax class.", - "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc/v3/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } + "description": "OK" } - }, + } + } + }, + "/carbon-fields/v1/terms/{id}": { + "get": { "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "patch": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } + "description": "OK" } - }, + } + } + }, + "/carbon-fields/v1/users/{id}": { + "get": { "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } + "responses": { + "200": { + "description": "OK" } } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc/v3/webhooks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "title"] } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to webhooks assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "required": true, "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - }, - "delivery_url": { "type": "string", "required": true, "description": "Webhook delivery URL." } - }, - "required": ["topic", "delivery_url"] - } - } - } - } - } - }, - "/wc/v3/webhooks/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v3/webhooks/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - } - }, - "/wc/v3/system_status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/system_status/tools": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v3/system_status/tools/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - } - }, - "/wc/v3/shipping_methods": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/shipping_methods/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v3/payment_gateways": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v3/payment_gateways/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } - } - } - } - } - } - }, - "/wc/v3/data": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc/v3/data/continents": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } } - } - } - } - }, - "/wc/v3/data/continents/{location}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_continents" } } } - } - }, - "parameters": [ - { - "name": "continent", - "in": "query", - "description": "2 character continent code.", - "required": false, - "schema": {} - }, - { "name": "location", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/v3/data/countries": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } - } - } - } - }, - "/wc/v3/data/countries/{location}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } - } - }, - "parameters": [ - { - "name": "location", - "in": "path", - "description": "ISO3166 alpha-2 country code.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/v3/data/currencies": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } } - } - } - } - }, - "/wc/v3/data/currencies/current": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } } - } - } - } - }, - "/wc/v3/data/currencies/{currency}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_currencies" } } } - } - }, - "parameters": [ - { - "name": "location", - "in": "query", - "description": "ISO4217 currency code.", - "required": false, - "schema": {} - }, - { "name": "currency", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/v3/orders/{id}/receipt": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier of the order.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "expiration_date": { "type": "string", "description": "Expiration date formatted as dd-mm-yyyy." }, - "expiration_days": { - "type": "integer", - "description": "Number of days to be added to the current date to get the expiration date." - }, - "force_new": { - "type": "boolean", - "required": false, - "description": "True to force the creation of a new receipt even if one already exists and has not expired yet." - } - } - } - } - } - } - }, - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier of the order.", - "required": true, - "schema": {} - } - ] - } - }, - "/wp-openapi/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp-openapi/v1/schema": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }] } }, "/jetpack/v4": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/jetpack/v4/verify_xmlrpc_error": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "nonce": { "type": "string", "required": true } }, - "required": ["nonce"] - } - } + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" } } } }, - "/jetpack/v4/verify_registration": { - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } }, - "patch": { "responses": { "200": { "description": "OK" } } } - }, - "/jetpack/v4/remote_authorize": { - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } }, - "patch": { "responses": { "200": { "description": "OK" } } } - }, "/jetpack/v4/connection": { - "get": { "responses": { "200": { "description": "OK" } } }, - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "isActive": { "required": true, "description": "Set to false will trigger the site to disconnect." } - }, - "required": ["isActive"] - } - } - } - } - }, - "put": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "isActive": { "required": true, "description": "Set to false will trigger the site to disconnect." } - }, - "required": ["isActive"] - } - } + "get": { + "responses": { + "200": { + "description": "OK" } } }, "patch": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "isActive": { "required": true, "description": "Set to false will trigger the site to disconnect." } + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } }, - "required": ["isActive"] + "required": [ + "isActive" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } } - } - }, - "/jetpack/v4/connection/data": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/jetpack/v4/connection/plugins": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/jetpack/v4/connection/reconnect": { - "post": { "responses": { "200": { "description": "OK" } } }, - "put": { "responses": { "200": { "description": "OK" } } }, - "patch": { "responses": { "200": { "description": "OK" } } } - }, - "/jetpack/v4/connection/register": { + }, "post": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "from": { - "type": "string", - "description": "Indicates where the registration action was triggered for tracking/segmentation purposes" - }, - "registration_nonce": { "type": "string", "required": true, "description": "The registration nonce" }, - "redirect_uri": { - "type": "string", - "description": "URI of the admin page where the user should be redirected after connection flow" - }, - "plugin_slug": { - "type": "string", - "description": "Indicates from what plugin the request is coming from" + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true } }, - "required": ["registration_nonce"] + "required": [ + "isActive" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } } }, "put": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "from": { - "type": "string", - "description": "Indicates where the registration action was triggered for tracking/segmentation purposes" - }, - "registration_nonce": { "type": "string", "required": true, "description": "The registration nonce" }, - "redirect_uri": { - "type": "string", - "description": "URI of the admin page where the user should be redirected after connection flow" - }, - "plugin_slug": { - "type": "string", - "description": "Indicates from what plugin the request is coming from" + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true } }, - "required": ["registration_nonce"] + "required": [ + "isActive" + ], + "type": "object" } } } - } - }, - "patch": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "from": { - "type": "string", - "description": "Indicates where the registration action was triggered for tracking/segmentation purposes" - }, - "registration_nonce": { "type": "string", "required": true, "description": "The registration nonce" }, - "redirect_uri": { - "type": "string", - "description": "URI of the admin page where the user should be redirected after connection flow" - }, - "plugin_slug": { - "type": "string", - "description": "Indicates from what plugin the request is coming from" - } - }, - "required": ["registration_nonce"] - } - } + }, + "responses": { + "200": { + "description": "OK" } } } }, "/jetpack/v4/connection/authorize_url": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ { - "name": "redirect_uri", - "in": "query", "description": "URI of the admin page where the user should be redirected after connection flow", + "in": "query", + "name": "redirect_uri", "required": false, "schema": {} } - ] + ], + "responses": { + "200": { + "description": "OK" + } + } } }, - "/jetpack/v4/user-token": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "user_token": { "type": "string", "required": true, "description": "New user token" }, - "is_connection_owner": { "type": "boolean", "description": "Is connection owner" } - }, - "required": ["user_token"] - } - } - } - } - }, - "put": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "user_token": { "type": "string", "required": true, "description": "New user token" }, - "is_connection_owner": { "type": "boolean", "description": "Is connection owner" } - }, - "required": ["user_token"] - } - } - } - } - }, - "patch": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "user_token": { "type": "string", "required": true, "description": "New user token" }, - "is_connection_owner": { "type": "boolean", "description": "Is connection owner" } - }, - "required": ["user_token"] - } - } + "/jetpack/v4/connection/data": { + "get": { + "responses": { + "200": { + "description": "OK" } } } }, "/jetpack/v4/connection/owner": { - "post": { - "responses": { "200": { "description": "OK" } }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "owner": { "type": "integer", "required": true, "description": "New owner" } }, - "required": ["owner"] + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } } }, "put": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "owner": { "type": "integer", "required": true, "description": "New owner" } }, - "required": ["owner"] + "properties": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "required": [ + "owner" + ], + "type": "object" } } } + }, + "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" + } + } + } + }, + "/jetpack/v4/connection/register": { "patch": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "owner": { "type": "integer", "required": true, "description": "New owner" } }, - "required": ["owner"] + "properties": { + "from": { + "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", + "type": "string" + }, + "plugin_slug": { + "description": "Indicates from what plugin the request is coming from", + "type": "string" + }, + "redirect_uri": { + "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" + } + }, + "required": [ + "registration_nonce" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "from": { + "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", + "type": "string" + }, + "plugin_slug": { + "description": "Indicates from what plugin the request is coming from", + "type": "string" + }, + "redirect_uri": { + "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" + } + }, + "required": [ + "registration_nonce" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "from": { + "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", + "type": "string" + }, + "plugin_slug": { + "description": "Indicates from what plugin the request is coming from", + "type": "string" + }, + "redirect_uri": { + "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" + } + }, + "required": [ + "registration_nonce" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/remote_authorize": { + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/user-token": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "user_token" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "user_token" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "user_token" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/verify_registration": { + "patch": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/jetpack/v4/verify_xmlrpc_error": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "nonce": { + "required": true, + "type": "string" + } + }, + "required": [ + "nonce" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } } } }, "/wc-admin": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc-admin/notice/dismiss": { "post": { "responses": { "200": { "description": "OK" } } } }, - "/wc-admin/features": { - "get": { + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "description": "OK" } } } @@ -25645,98 +26190,324 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } }, - "/wc-admin/marketing/recommended": { + "/wc-admin/features": { "get": { "responses": { "200": { - "description": "OK", - "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" + } + } + } + }, + "/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" + } + } } }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/launch-your-store/woopayments/test-orders": { + "delete": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/launch-your-store/woopayments/test-orders/count": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/marketing/campaign-types": { + "get": { "parameters": [ { - "name": "per_page", + "description": "Scope under which the request is made; determines fields present in response.", "in": "query", - "description": "Maximum number of items to be returned in result set.", + "name": "context", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "enum": [ + "view" + ] + } }, - { "name": "category", "in": "query", "description": "", "required": false, "schema": {} } - ] + { + "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 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign_type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/marketing/campaigns": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "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 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_campaign" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/marketing/channels": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_channel" + } + } + }, + "description": "OK" + } + } } }, "/wc-admin/marketing/knowledge-base": { "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "category", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "category", "in": "query", "description": "", "required": false, "schema": {} }] + } } }, "/wc-admin/marketing/overview/activate-plugin": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "plugin": { "type": "string", "required": true } }, - "required": ["plugin"] + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "plugin": { "type": "string", "required": true } }, - "required": ["plugin"] + "properties": { + "plugin": { + "required": true, + "type": "string" + } + }, + "required": [ + "plugin" + ], + "type": "object" } } } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "plugin": { "type": "string", "required": true } }, - "required": ["plugin"] + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } } - } + }, + "description": "OK" } } } @@ -25745,1148 +26516,79 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } }, "/wc-admin/marketing/recommendations": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_recommendation" } } - } - } - }, "parameters": [ { - "name": "category", - "in": "query", "description": "", + "in": "query", + "name": "category", "required": true, - "schema": { "enum": ["channels", "extensions"] } + "schema": { + "enum": [ + "channels", + "extensions" + ] + } } - ] - } - }, - "/wc-admin/marketing/channels": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_channel" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketing_recommendation" + } + } + }, + "description": "OK" } } } }, - "/wc-admin/marketing/campaigns": { + "/wc-admin/marketing/recommended": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - } - ] - } - }, - "/wc-admin/marketing/campaign-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/marketing_campaign_type" } } - } - } - }, - "parameters": [ - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", "required": false, - "schema": { "minimum": 1, "maximum": 100 } - } - ] - } - }, - "/wc-admin/options": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/options" } } } - } - } - } - }, - "/wc-admin/payment-gateway-suggestions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } + "schema": { + "maximum": 100, + "minimum": 1 } - } - }, - "parameters": [ - { - "name": "force_default_suggestions", - "in": "query", - "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-admin/payment-gateway-suggestions/dismiss": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/payment-gateway-suggestions" } } - } - } - } - } - }, - "/wc-admin/themes": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "pluginzip": { "type": "file", "description": "A zip file of the theme to be uploaded." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "pluginzip": { "type": "file", "description": "A zip file of the theme to be uploaded." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_theme" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "pluginzip": { "type": "file", "description": "A zip file of the theme to be uploaded." } - } - } - } - } - } - } - }, - "/wc-admin/plugins/install": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/install/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/install/status/{job_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - }, - "parameters": [{ "name": "job_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/plugins/active": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/installed": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/activate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/activate/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/activate/status/{job_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - }, - "parameters": [{ "name": "job_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/plugins/connect-jetpack": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/request-wccom-connect": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/finish-wccom-connect": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/connect-wcpay": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/plugins/connect-square": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugins" } } } - } - } - } - }, - "/wc-admin/onboarding/free-extensions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/product-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/profile": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "completed": { "type": "boolean", "description": "Whether or not the profile was completed." }, - "skipped": { "type": "boolean", "description": "Whether or not the profile was skipped." }, - "industry": { "type": "array", "description": "Industry." }, - "product_types": { "type": "array", "description": "Types of products sold." }, - "product_count": { "type": "string", "description": "Number of products to be added." }, - "selling_venues": { "type": "string", "description": "Other places the store is selling products." }, - "number_employees": { "type": "string", "description": "Number of employees of the store." }, - "revenue": { "type": "string", "description": "Current annual revenue of the store." }, - "other_platform": { "type": "string", "description": "Name of other platform used to sell." }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed)." - }, - "business_extensions": { "type": "array", "description": "Extra business extensions to install." }, - "theme": { "type": "string", "description": "Selected store theme." }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client." - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow." - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com." - }, - "store_email": { "type": "string", "description": "Store email address." }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler." - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped." - }, - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "completed": { "type": "boolean", "description": "Whether or not the profile was completed." }, - "skipped": { "type": "boolean", "description": "Whether or not the profile was skipped." }, - "industry": { "type": "array", "description": "Industry." }, - "product_types": { "type": "array", "description": "Types of products sold." }, - "product_count": { "type": "string", "description": "Number of products to be added." }, - "selling_venues": { "type": "string", "description": "Other places the store is selling products." }, - "number_employees": { "type": "string", "description": "Number of employees of the store." }, - "revenue": { "type": "string", "description": "Current annual revenue of the store." }, - "other_platform": { "type": "string", "description": "Name of other platform used to sell." }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed)." - }, - "business_extensions": { "type": "array", "description": "Extra business extensions to install." }, - "theme": { "type": "string", "description": "Selected store theme." }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client." - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow." - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com." - }, - "store_email": { "type": "string", "description": "Store email address." }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler." - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped." - }, - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "completed": { "type": "boolean", "description": "Whether or not the profile was completed." }, - "skipped": { "type": "boolean", "description": "Whether or not the profile was skipped." }, - "industry": { "type": "array", "description": "Industry." }, - "product_types": { "type": "array", "description": "Types of products sold." }, - "product_count": { "type": "string", "description": "Number of products to be added." }, - "selling_venues": { "type": "string", "description": "Other places the store is selling products." }, - "number_employees": { "type": "string", "description": "Number of employees of the store." }, - "revenue": { "type": "string", "description": "Current annual revenue of the store." }, - "other_platform": { "type": "string", "description": "Name of other platform used to sell." }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed)." - }, - "business_extensions": { "type": "array", "description": "Extra business extensions to install." }, - "theme": { "type": "string", "description": "Selected store theme." }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client." - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow." - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com." - }, - "store_email": { "type": "string", "description": "Store email address." }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler." - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped." - }, - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - } - }, - "/wc-admin/onboarding/profile/experimental_get_email_prefill": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_profile" } } } - } - } - } - }, - "/wc-admin/onboarding/tasks/import_sample_products": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/tasks/create_homepage": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/onboarding/tasks/create_product_from_template": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "template_name": { "type": "string", "required": true, "description": "Product template name." } - }, - "required": ["template_name"] - } - } - } - } - } - }, - "/wc-admin/onboarding/tasks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [ - { - "name": "ids", - "in": "query", - "description": "Optional parameter to get only specific task lists by ID.", - "required": false, - "schema": { "items": { "enum": ["setup", "extended", "secret_tasklist"], "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "ids": { - "type": "array", - "description": "Optional parameter to get only specific task lists by ID." - }, - "extended_tasks": { - "type": "array", - "description": "List of extended deprecated tasks from the client-side filter." - } - } - } - } - } - } - } - }, - "/wc-admin/onboarding/tasks/{id}/hide": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/unhide": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/dismiss": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/undo_dismiss": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/snooze": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "duration": { "type": "string", "description": "Time period to snooze the task." }, - "task_list_id": { "type": "string", "description": "Optional parameter to query specific task list." } - } - } - } - } - } - } - }, - "/wc-admin/onboarding/tasks/{id}/action": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/tasks/{id}/undo_snooze": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/themes/install": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - } - }, - "/wc-admin/onboarding/themes/activate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onboarding_theme" } } } - } - } - } - }, - "/wc-admin/onboarding/themes/recommended": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "industry", - "in": "query", - "description": "Limits the results to themes relevant for this industry (optional)", - "required": false, - "schema": {} }, { - "name": "currency", + "description": "", "in": "query", - "description": "Returns pricing in this currency (optional, default: USD)", + "name": "category", "required": false, - "schema": { "enum": ["USD", "AUD", "CAD", "EUR", "GBP"] } + "schema": {} } - ] - } - }, - "/wc-admin/onboarding/plugins/install-and-activate-async": { - "post": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "plugins": { "type": "array", "required": true, "description": "A list of plugins to install" } - }, - "required": ["plugins"] - } - } - } - } - } - }, - "/wc-admin/onboarding/plugins/install-and-activate": { - "post": { - "responses": { - "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Install and Activate Schema" } } - } - } - } - } - }, - "/wc-admin/onboarding/plugins/scheduled-installs/{job_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Install Async Schema" } } } - } - }, - "parameters": [{ "name": "job_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wc-admin/onboarding/plugins/jetpack-authorization-url": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "redirect_url", - "in": "query", - "description": "The URL to redirect to after authorization", - "required": true, - "schema": {} - }, - { - "name": "from", - "in": "query", - "description": "from value for the jetpack authorization page", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-admin/onboarding/products": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-admin/navigation/favorites/me": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "item_id": { "required": true } }, "required": ["item_id"] } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "item_id": { "required": true } }, "required": ["item_id"] } - } - } - } - } - }, - "/wc-admin/mobile-app/send-magic-link": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } @@ -26895,4775 +26597,4288 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/mobile-app/send-magic-link": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/navigation/favorites/me": { + "delete": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "item_id": { + "required": true + } + }, + "required": [ + "item_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "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" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/install-and-activate": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install and Activate Schema" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/install-and-activate-async": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "plugins": { + "description": "A list of plugins to install", + "required": true, + "type": "array" + } + }, + "required": [ + "plugins" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/jetpack-authorization-url": { + "get": { + "parameters": [ + { + "description": "The URL to redirect to after authorization", + "in": "query", + "name": "redirect_url", + "required": true, + "schema": {} + }, + { + "description": "from value for the jetpack authorization page", + "in": "query", + "name": "from", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/plugins/scheduled-installs/{job_id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Install Async Schema" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/product-types": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/products": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/profile": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "requestBody": { + "content": { + "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" + }, + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "industry": { + "description": "Industry.", + "type": "array" + }, + "is_agree_marketing": { + "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", + "type": "boolean" + }, + "is_plugins_page_skipped": { + "description": "Whether or not plugins step in core profiler was skipped.", + "type": "boolean" + }, + "is_store_country_set": { + "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" + }, + "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" + }, + "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" + }, + "wccom_connected": { + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "industry": { + "description": "Industry.", + "type": "array" + }, + "is_agree_marketing": { + "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", + "type": "boolean" + }, + "is_plugins_page_skipped": { + "description": "Whether or not plugins step in core profiler was skipped.", + "type": "boolean" + }, + "is_store_country_set": { + "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" + }, + "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" + }, + "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" + }, + "wccom_connected": { + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "industry": { + "description": "Industry.", + "type": "array" + }, + "is_agree_marketing": { + "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", + "type": "boolean" + }, + "is_plugins_page_skipped": { + "description": "Whether or not plugins step in core profiler was skipped.", + "type": "boolean" + }, + "is_store_country_set": { + "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" + }, + "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" + }, + "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" + }, + "wccom_connected": { + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/profile/experimental_get_email_prefill": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_profile" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks": { + "get": { + "parameters": [ + { + "description": "Optional parameter to get only specific task lists by ID.", + "in": "query", + "name": "ids", + "required": false, + "schema": { + "items": { + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extended_tasks": { + "description": "List of extended deprecated tasks from the client-side filter.", + "type": "array" + }, + "ids": { + "description": "Optional parameter to get only specific task lists by ID.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/create_homepage": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/create_product_from_template": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "template_name": { + "description": "Product template name.", + "required": true, + "type": "string" + } + }, + "required": [ + "template_name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/import_sample_products": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/action": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/dismiss": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/hide": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/snooze": { + "post": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/undo_dismiss": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/undo_snooze": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/tasks/{id}/unhide": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/themes/activate": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/themes/install": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/onboarding_theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/onboarding/themes/recommended": { + "get": { + "parameters": [ + { + "description": "Limits the results to themes relevant for this industry (optional)", + "in": "query", + "name": "industry", + "required": false, + "schema": {} + }, + { + "description": "Returns pricing in this currency (optional, default: USD)", + "in": "query", + "name": "currency", + "required": false, + "schema": { + "enum": [ + "AUD", + "CAD", + "EUR", + "GBP", + "USD" + ] + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-admin/options": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/options" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/payment-gateway-suggestions": { + "get": { + "parameters": [ + { + "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", + "in": "query", + "name": "force_default_suggestions", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/payment-gateway-suggestions/dismiss": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment-gateway-suggestions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/activate": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/activate/status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/activate/status/{job_id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/active": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/connect-jetpack": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/connect-square": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/connect-wcpay": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/finish-wccom-connect": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/install": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/install/status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/install/status/{job_id}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "job_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/installed": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-admin/plugins/request-wccom-connect": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugins" + } + } + }, + "description": "OK" } } } }, "/wc-admin/shipping-partner-suggestions": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping-partner-suggestions" } } - } - } - }, "parameters": [ { - "name": "force_default_suggestions", - "in": "query", "description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no", + "in": "query", + "name": "force_default_suggestions", "required": false, "schema": {} } - ] - } - }, - "/wc-admin/launch-your-store/initialize-coming-soon": { - "post": { "responses": { "200": { "description": "OK" } } } - }, - "/wc-admin/launch-your-store/update-survey-status": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "status": { "type": "string" } } } - } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping-partner-suggestions" + } + } + }, + "description": "OK" } } } }, - "/wc-admin/launch-your-store/survey-completed": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wc-admin/launch-your-store/woopayments/test-orders/count": { - "get": { "responses": { "200": { "description": "OK" } } } - }, - "/wc-admin/launch-your-store/woopayments/test-orders": { - "delete": { "responses": { "200": { "description": "OK" } } } + "/wc-admin/themes": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/upload_theme" + } + } + }, + "description": "OK" + } + } + } }, "/wc-analytics": { "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc-analytics/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "users", - "in": "query", - "description": "Limit result to items with specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "filter_empty", - "in": "query", - "description": "Filter out results where any of the passed fields are empty", - "required": false, - "schema": { - "items": { "type": "string", "enum": ["email", "name", "country", "city", "state", "postcode"] } - } - }, - { - "name": "include", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wc-analytics/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "users", - "in": "query", - "description": "Limit result to items with specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "filter_empty", - "in": "query", - "description": "Filter out results where any of the passed fields are empty", - "required": false, - "schema": { - "items": { "type": "string", "enum": ["email", "name", "country", "city", "state", "postcode"] } - } - }, - { - "name": "include", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wc-analytics/leaderboards": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } } - } - }, - "parameters": [ - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 20 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "persisted_query", - "in": "query", - "description": "URL query to persist across links.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/leaderboards/allowed": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } } - } - } - } - }, - "/wc-analytics/leaderboards/{leaderboard}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/leaderboard" } } } - } - }, - "parameters": [ - { - "name": "leaderboard", - "in": "path", "description": "", - "required": true, - "schema": { "enum": ["customers", "coupons", "categories", "products"] } - }, - { - "name": "page", "in": "query", - "description": "Current page of the collection.", + "name": "namespace", "required": false, - "schema": { "minimum": 1 } + "schema": {} }, { - "name": "per_page", + "description": "", "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 20 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "persisted_query", - "in": "query", - "description": "URL query to persist across links.", + "name": "context", "required": false, "schema": {} } - ] - } - }, - "/wc-analytics/reports": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc-analytics/reports/import": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "days": { "type": "integer", "description": "Number of days to import." }, - "skip_existing": { "type": "boolean", "description": "Skip importing existing order data." } - } - } - } + "description": "OK" } } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "days": { "type": "integer", "description": "Number of days to import." }, - "skip_existing": { "type": "boolean", "description": "Skip importing existing order data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "days": { "type": "integer", "description": "Number of days to import." }, - "skip_existing": { "type": "boolean", "description": "Skip importing existing order data." } - } - } - } - } - } - } - }, - "/wc-analytics/reports/import/cancel": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - } - }, - "/wc-analytics/reports/import/delete": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - } - }, - "/wc-analytics/reports/import/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - } - } - }, - "/wc-analytics/reports/import/totals": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_import" } } } - } - }, - "parameters": [ - { - "name": "days", - "in": "query", - "description": "Number of days to import.", - "required": false, - "schema": { "minimum": 0 } - }, - { - "name": "skip_existing", - "in": "query", - "description": "Skip importing existing order data.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/{type}/export": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } } - } - }, - "parameters": [{ "name": "type", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "report_args": { "type": "object", "description": "Parameters to pass on to the exported report." }, - "email": { - "type": "boolean", - "description": "When true, email a link to download the export to the requesting user." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } } - } - }, - "parameters": [{ "name": "type", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "report_args": { "type": "object", "description": "Parameters to pass on to the exported report." }, - "email": { - "type": "boolean", - "description": "When true, email a link to download the export to the requesting user." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export" } } } - } - }, - "parameters": [{ "name": "type", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "report_args": { "type": "object", "description": "Parameters to pass on to the exported report." }, - "email": { - "type": "boolean", - "description": "When true, email a link to download the export to the requesting user." - } - } - } - } - } - } - } - }, - "/wc-analytics/reports/{type}/export/{export_id}/status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_export_status" } } } - } - }, - "parameters": [ - { "name": "type", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "export_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc-analytics/reports/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_products" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": ["date", "net_revenue", "orders_count", "items_sold", "product_name", "variations", "sku"] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "categories", - "in": "query", - "description": "Limit result to items from the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "products", - "in": "query", - "description": "Limit result to items with specified product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each product to the report.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_varitations" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "items_sold", "sku"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variations", - "in": "query", - "description": "Limit result to items with specified variation IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each variation to the report.", - "required": false, - "schema": {} - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to variations that include the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to variations that don't include the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "category_includes", - "in": "query", - "description": "Limit result set to variations in the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "category_excludes", - "in": "query", - "description": "Limit result set to variations not in the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "products", - "in": "query", - "description": "Limit result to items with specified product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wc-analytics/reports/products/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_products_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result to items from the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "products", - "in": "query", - "description": "Limit result to items with specified product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variations", - "in": "query", - "description": "Limit result to items with specified variation IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/variations/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_variations_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "category_includes", - "in": "query", - "description": "Limit result to items from the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "category_excludes", - "in": "query", - "description": "Limit result set to variations not in the specified categories.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified parent product(s).", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variations", - "in": "query", - "description": "Limit result to items with specified variation IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to orders that include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to orders that don't include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - } - ] - } - }, - "/wc-analytics/reports/revenue/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_revenue_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "total_sales", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold", - "gross_sales" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } - }, - { - "name": "date_type", - "in": "query", - "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", - "required": false, - "schema": { "enum": ["date_paid", "date_created", "date_completed"] } - } - ] - } - }, - "/wc-analytics/reports/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "num_items_sold", "net_total"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_includes", - "in": "query", - "description": "Limit result set to items that have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_includes", - "in": "query", - "description": "Limit result set to items that have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_includes", - "in": "query", - "description": "Limit result set to items that have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status_is", - "in": "query", - "description": "Limit result set to items that have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "status_is_not", - "in": "query", - "description": "Limit result set to items that don't have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "customer_type", - "in": "query", - "description": "Limit result set to returning or new customers.", - "required": false, - "schema": { "enum": ["", "returning", "new"] } - }, - { - "name": "refunds", - "in": "query", - "description": "Limit result set to specific types of refunds.", - "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each coupon to the report.", - "required": false, - "schema": {} - }, - { - "name": "order_includes", - "in": "query", - "description": "Limit result set to items that have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to orders that include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to orders that don't include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/orders/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "net_revenue", "orders_count", "avg_order_value"] } - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "status_is", - "in": "query", - "description": "Limit result set to items that have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "status_is_not", - "in": "query", - "description": "Limit result set to items that don't have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_includes", - "in": "query", - "description": "Limit result set to items that have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "variation_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified variation(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_includes", - "in": "query", - "description": "Limit result set to items that have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "coupon_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified coupon(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_includes", - "in": "query", - "description": "Limit result set to items that have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "tax_rate_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer", - "in": "query", - "description": "Alias for customer_type (deprecated).", - "required": false, - "schema": { "enum": ["new", "returning"] } - }, - { - "name": "customer_type", - "in": "query", - "description": "Limit result set to orders that have the specified customer_type", - "required": false, - "schema": { "enum": ["new", "returning"] } - }, - { - "name": "refunds", - "in": "query", - "description": "Limit result set to specific types of refunds.", - "required": false, - "schema": { "enum": ["", "all", "partial", "full", "none"] } - }, - { - "name": "attribute_is", - "in": "query", - "description": "Limit result set to orders that include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "attribute_is_not", - "in": "query", - "description": "Limit result set to orders that don't include products with the specified attributes.", - "required": false, - "schema": { "items": { "type": "array" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "category", "variation", "coupon", "customer_type"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_categories" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": ["category_id", "items_sold", "net_revenue", "orders_count", "products_count", "category"] - } - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "status_is", - "in": "query", - "description": "Limit result set to items that have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "status_is_not", - "in": "query", - "description": "Limit result set to items that don't have the specified order status.", - "required": false, - "schema": { - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - } - } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each category to the report.", - "required": false, - "schema": {} - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "name", - "tax_rate_id", - "tax_code", - "rate", - "order_tax", - "total_tax", - "shipping_tax", - "orders_count" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "taxes", - "in": "query", - "description": "Limit result set to items assigned one or more tax rates.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/taxes/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_taxes_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "items_sold", "total_sales", "orders_count", "products_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "taxes", - "in": "query", - "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["tax_rate_id"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["coupon_id", "code", "amount", "orders_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "coupons", - "in": "query", - "description": "Limit result set to coupons assigned specific coupon IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "extended_info", - "in": "query", - "description": "Add additional piece of info about each coupon to the report.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/coupons/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_coupons_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "amount", "coupons_count", "orders_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "coupons", - "in": "query", - "description": "Limit result set to coupons assigned specific coupon IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "segmentby", - "in": "query", - "description": "Segment the response by additional constraint.", - "required": false, - "schema": { "enum": ["product", "variation", "category", "coupon"] } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/stock": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_stock" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["stock_status", "stock_quantity", "date", "id", "include", "title", "sku"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to items assigned a stock report type.", - "required": false, - "schema": { "enum": ["all", "lowstock", "instock", "outofstock", "onbackorder"] } - } - ] - } - }, - "/wc-analytics/reports/stock/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc-analytics/reports/downloads": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_downloads" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "product"] } - }, - { - "name": "match", - "in": "query", - "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.", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_includes", - "in": "query", - "description": "Limit result set to items that have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_includes", - "in": "query", - "description": "Limit response to objects that have the specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_excludes", - "in": "query", - "description": "Limit response to objects that don't have the specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "ip_address_includes", - "in": "query", - "description": "Limit response to objects that have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "ip_address_excludes", - "in": "query", - "description": "Limit response to objects that don't have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/downloads/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_orders_stats" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "download_count"] } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "interval", - "in": "query", - "description": "Time interval to use for buckets in the returned data.", - "required": false, - "schema": { "enum": ["hour", "day", "week", "month", "quarter", "year"] } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "product_includes", - "in": "query", - "description": "Limit result set to items that have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "product_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_includes", - "in": "query", - "description": "Limit result set to items that have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order_excludes", - "in": "query", - "description": "Limit result set to items that don't have the specified order IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_includes", - "in": "query", - "description": "Limit response to objects that have the specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "customer_excludes", - "in": "query", - "description": "Limit response to objects that don't have the specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "ip_address_includes", - "in": "query", - "description": "Limit response to objects that have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "ip_address_excludes", - "in": "query", - "description": "Limit response to objects that don't have a specified IP address.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - } - }, - "/wc-analytics/reports/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_customers" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ] - } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "customers", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "users", - "in": "query", - "description": "Limit result to items with specified user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "filter_empty", - "in": "query", - "description": "Filter out results where any of the passed fields are empty", - "required": false, - "schema": { - "items": { "type": "string", "enum": ["email", "name", "country", "city", "state", "postcode"] } - } - } - ] - } - }, - "/wc-analytics/reports/customers/stats": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_customers_stats" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "registered_before", - "in": "query", - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "registered_after", - "in": "query", - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "match", - "in": "query", - "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", - "required": false, - "schema": { "enum": ["all", "any"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "required": false, - "schema": {} - }, - { - "name": "searchby", - "in": "query", - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "required": false, - "schema": { "enum": ["name", "username", "email", "all"] } - }, - { - "name": "name_includes", - "in": "query", - "description": "Limit response to objects with specific names.", - "required": false, - "schema": {} - }, - { - "name": "name_excludes", - "in": "query", - "description": "Limit response to objects excluding specific names.", - "required": false, - "schema": {} - }, - { - "name": "username_includes", - "in": "query", - "description": "Limit response to objects with specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "username_excludes", - "in": "query", - "description": "Limit response to objects excluding specific usernames.", - "required": false, - "schema": {} - }, - { - "name": "email_includes", - "in": "query", - "description": "Limit response to objects including emails.", - "required": false, - "schema": {} - }, - { - "name": "email_excludes", - "in": "query", - "description": "Limit response to objects excluding emails.", - "required": false, - "schema": {} - }, - { - "name": "country_includes", - "in": "query", - "description": "Limit response to objects with specific countries.", - "required": false, - "schema": {} - }, - { - "name": "country_excludes", - "in": "query", - "description": "Limit response to objects excluding specific countries.", - "required": false, - "schema": {} - }, - { - "name": "last_active_before", - "in": "query", - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_after", - "in": "query", - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_active_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "registered_between", - "in": "query", - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "orders_count_min", - "in": "query", - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_max", - "in": "query", - "description": "Limit response to objects with an order count less than or equal to given integer.", - "required": false, - "schema": {} - }, - { - "name": "orders_count_between", - "in": "query", - "description": "Limit response to objects with an order count between two given integers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "total_spend_min", - "in": "query", - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_max", - "in": "query", - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "total_spend_between", - "in": "query", - "description": "Limit response to objects with a total order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "avg_order_value_min", - "in": "query", - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_max", - "in": "query", - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "required": false, - "schema": {} - }, - { - "name": "avg_order_value_between", - "in": "query", - "description": "Limit response to objects with an average order spend between two given numbers.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "last_order_before", - "in": "query", - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "last_order_after", - "in": "query", - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "customers", - "in": "query", - "description": "Limit result to items with specified customer IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "fields", - "in": "query", - "description": "Limit stats fields to the specified items.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "force_cache_refresh", - "in": "query", - "description": "Force retrieval of fresh data instead of from the cache.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/reports/performance-indicators": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "stats", - "in": "query", - "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.", - "required": false, - "schema": { - "items": { - "type": "string", - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - } - } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - } - ] - } - }, - "/wc-analytics/reports/performance-indicators/allowed": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/report_performance_indicator" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "stats", - "in": "query", - "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.", - "required": false, - "schema": { - "items": { - "type": "string", - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - } - } - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - } - ] } }, "/wc-analytics/admin/notes": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "type", - "in": "query", "description": "Type of note.", + "in": "query", + "name": "type", "required": false, "schema": { "items": { - "enum": ["error", "warning", "update", "info", "marketing", "survey", "email"], + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], "type": "string" } } }, { - "name": "status", - "in": "query", "description": "Status of note.", + "in": "query", + "name": "status", "required": false, "schema": { - "items": { "enum": ["pending", "actioned", "unactioned", "snoozed", "sent"], "type": "string" } + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + } } }, { - "name": "source", - "in": "query", "description": "Source of note.", + "in": "query", + "name": "source", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } } - ] - } - }, - "/wc-analytics/admin/notes/{id}": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - } - }, - "/wc-analytics/admin/notes/delete/{id}": { - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] + } } }, "/wc-analytics/admin/notes/delete/all": { "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { "status": { "type": "array", "description": "Status of note." } } + "properties": { + "status": { + "description": "Status of note.", + "type": "array" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/admin/notes/delete/{id}": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/admin/notes/experimental-activate-promo/{promo_note_name}": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "promo_note_name", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } } } }, "/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": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "note_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} } - ] + } } }, "/wc-analytics/admin/notes/update": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } + }, "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } } }, "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } } } }, - "/wc-analytics/admin/notes/experimental-activate-promo/{promo_note_name}": { - "post": { + "/wc-analytics/admin/notes/{id}": { + "get": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "promo_note_name", "in": "path", "description": "", "required": true, "schema": {} }] - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, - "parameters": [{ "name": "promo_note_name", "in": "path", "description": "", "required": true, "schema": {} }] + } }, "patch": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "promo_note_name", "in": "path", "description": "", "required": true, "schema": {} }] + } + }, + "post": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } } }, "/wc-analytics/admin/notes/{note_id}/action/{action_id}": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, + "patch": { "parameters": [ - { "name": "note_id", "in": "path", "description": "Unique ID for the Note.", "required": true, "schema": {} }, { - "name": "action_id", + "description": "Unique ID for the Note.", "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, + { "description": "Unique ID for the Note Action.", + "in": "path", + "name": "action_id", "required": true, "schema": {} } - ] + ], + "responses": { + "200": { + "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 Action.", + "in": "path", + "name": "action_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" + } + } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } - } - }, "parameters": [ - { "name": "note_id", "in": "path", "description": "Unique ID for the Note.", "required": true, "schema": {} }, { - "name": "action_id", + "description": "Unique ID for the Note.", "in": "path", + "name": "note_id", + "required": true, + "schema": {} + }, + { "description": "Unique ID for the Note Action.", + "in": "path", + "name": "action_id", "required": true, "schema": {} } - ] - }, - "patch": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/note" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/note" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "note_id", "in": "path", "description": "Unique ID for the Note.", "required": true, "schema": {} }, - { - "name": "action_id", - "in": "path", - "description": "Unique ID for the Note Action.", - "required": true, - "schema": {} - } - ] + } } }, "/wc-analytics/coupons": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to coupons with codes matching a given string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "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" + ] + } }, { - "name": "code", - "in": "query", "description": "Limit result set to resources with a specific code.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["code"] - } - } - } - } - } - }, - "/wc-analytics/coupons/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "code", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "description": { + "description": "Coupon description.", + "type": "string" }, "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" }, "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" }, "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." + "description": "How many times the coupon can be used in total.", + "type": "integer" }, "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" } } } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" } } - } + }, + "description": "OK" } } } }, "/wc-analytics/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." + "description": { + "description": "Coupon description.", + "type": "string" }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." + "description": { + "description": "Coupon description.", + "type": "string" }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/coupons/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Coupon code." }, "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" + "code": { + "description": "Coupon code.", + "type": "string" }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." + "description": { + "description": "Coupon description.", + "type": "string" }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/customers": { + "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": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "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" + } + }, + { + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified user IDs.", + "in": "query", + "name": "users", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Filter out results where any of the passed fields are empty", + "in": "query", + "name": "filter_empty", + "required": false, + "schema": { + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/customers/{id}": { + "get": { + "parameters": [ + { + "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": [ + "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": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "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" + } + }, + { + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified user IDs.", + "in": "query", + "name": "users", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Filter out results where any of the passed fields are empty", + "in": "query", + "name": "filter_empty", + "required": false, + "schema": { + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, + "description": "OK" + } } } }, @@ -31671,18 +30886,14 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_index" } } } - } - } - } - }, - "/wc-analytics/data/countries/locales": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" } } } @@ -31691,4898 +30902,4238 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/data/countries/locales": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" } } } }, "/wc-analytics/data/countries/{location}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_countries" } } } - } - }, "parameters": [ { - "name": "location", - "in": "path", "description": "ISO3166 alpha-2 country code.", + "in": "path", + "name": "location", "required": true, "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } } }, "/wc-analytics/data/download-ips": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_download_ips" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_download_ips" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/leaderboards": { + "get": { + "parameters": [ + { + "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": 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" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "URL query to persist across links.", + "in": "query", + "name": "persisted_query", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/leaderboards/allowed": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/leaderboards/{leaderboard}": { + "get": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "leaderboard", + "required": true, + "schema": { + "enum": [ + "categories", + "coupons", + "customers", + "products" + ] + } + }, + { + "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": 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" + } + }, + { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "URL query to persist across links.", + "in": "query", + "name": "persisted_query", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/leaderboard" + } + } + }, + "description": "OK" } } } }, "/wc-analytics/orders": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders which have specific statuses.", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to orders which have specific statuses.", + "in": "query", + "name": "status", "required": false, "schema": { "items": { - "type": "string", "enum": [ "any", - "trash", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", "pending", "processing", - "on-hold", - "completed", - "cancelled", "refunded", - "failed", - "checkout-draft" - ] + "trash" + ], + "type": "string" } } }, { - "name": "customer", - "in": "query", "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", "required": false, "schema": {} }, { - "name": "product", - "in": "query", "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", "required": false, "schema": {} }, { - "name": "dp", - "in": "query", "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", "required": false, "schema": {} }, { - "name": "order_item_display_meta", - "in": "query", "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", "required": false, "schema": {} }, { - "name": "include_meta", - "in": "query", "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "exclude_meta", - "in": "query", "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "number", - "in": "query", "description": "Limit result set to orders matching part of an order number.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - } - }, - "/wc-analytics/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "number", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "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" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "type": "boolean" }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" } } } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." - } - } - } - } - } - } - }, - "delete": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" } } - } + }, + "description": "OK" } } } }, "/wc-analytics/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." + "billing": { + "description": "Billing address.", + "type": "object" }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." + "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" }, "manual_update": { - "type": "boolean", - "description": "Set the action as manual so that the order note registers as \"added by user\"." + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Search by similar product name or SKU.", - "required": false, - "schema": {} - }, - { - "name": "after", "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order", - "price", - "popularity", - "rating" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "search_sku", - "in": "query", - "description": "Limit results to those with a SKU that partially matches a string.", - "required": false, - "schema": {} - }, - { - "name": "low_in_stock", - "in": "query", - "description": "Limit result set to products that are low or out of stock. (Deprecated)", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc-analytics/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc-analytics/products/suggested-products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", "required": false, "schema": { "enum": [ "date", "id", "include", - "title", - "slug", + "menu_order", "modified", "popularity", - "rating", "popularity", + "popularity", + "price", "rating", - "menu_order" + "rating", + "rating", + "slug", + "title" ] } }, { - "name": "parent", - "in": "query", "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "parent_exclude", - "in": "query", "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" + } + } }, { - "name": "slug", - "in": "query", "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", "required": false, "schema": {} }, { - "name": "status", - "in": "query", "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { - "name": "type", - "in": "query", "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" + ] + } }, { - "name": "sku", - "in": "query", "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", "required": false, "schema": {} }, { - "name": "featured", - "in": "query", "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", "required": false, "schema": {} }, { - "name": "category", - "in": "query", "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", "required": false, "schema": {} }, { - "name": "tag", - "in": "query", "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", "required": false, "schema": {} }, { - "name": "shipping_class", - "in": "query", "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", "required": false, "schema": {} }, { - "name": "attribute", - "in": "query", "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", "required": false, "schema": {} }, { - "name": "attribute_term", - "in": "query", "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", "required": false, "schema": {} }, { - "name": "in_stock", - "in": "query", - "description": "Limit result set to products in stock or out of stock.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", "required": false, "schema": {} }, { - "name": "min_price", - "in": "query", "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", "required": false, "schema": {} }, { - "name": "max_price", - "in": "query", "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", "required": false, "schema": {} }, { - "name": "include_meta", - "in": "query", "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "exclude_meta", - "in": "query", "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "categories", + "description": "Limit result set to products with specified stock status.", "in": "query", - "description": "Limit result set to specific product categorie ids.", + "name": "stock_status", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } }, { - "name": "tags", + "description": "Limit results to those with a SKU that partially matches a string.", "in": "query", - "description": "Limit result set to specific product tag ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "limit", - "in": "query", - "description": "Limit result set to specific amount of suggested products.", + "name": "search_sku", "required": false, "schema": {} - } - ] - } - }, - "/wc-analytics/products/{id}/duplicate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ + }, { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, + "description": "Limit result set to products that are low or out of stock. (Deprecated)", + "in": "query", + "name": "low_in_stock", + "required": false, "schema": {} } ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the product was created, in the site's timezone." + "attributes": { + "description": "List of attributes.", + "type": "array" }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the product was created, as GMT." - }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "description": "Product external button text. Only for external products.", + "type": "string" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "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" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" }, "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the product." + "description": "Low Stock amount for the product.", + "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" + }, + "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" }, "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "description": "Allow one item to be bought in a single order.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "post_password": { "type": "string", "description": "Post password." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "status": { + "description": "Product status (post status).", + "type": "string" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/attributes": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "search", - "in": "query", "description": "Search by similar attribute name.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc-analytics/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "search", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": {} } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "order_by": { + "description": "Default sort order.", + "type": "string" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" } - } + }, + "required": [ + "name" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } + "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": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "has_archives": { + "description": "Enable/Disable attribute archives.", + "type": "boolean" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } + "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": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "description": { + "description": "HTML description of the resource.", + "type": "string" }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/attributes/{slug}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, "parameters": [ { - "name": "slug", - "in": "path", "description": "Slug identifier for the resource.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc-analytics/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, + "required": true, "schema": {} } - ] - }, - "post": { + ], "responses": { "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc-analytics/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc-analytics/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } + }, + "description": "OK" } } } }, "/wc-analytics/products/attributes/{slug}/terms": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, "parameters": [ { - "name": "slug", - "in": "path", "description": "Limit result set to resources with a specific slug.", + "in": "path", + "name": "slug", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc-analytics/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "enum": [ + "edit", + "view" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", "in": "query", - "description": "Limit result set to specific ids.", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] + "schema": { + "items": { + "type": "integer" } } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" } } } }, - "/wc-analytics/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], + "/wc-analytics/products/batch": { + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "attributes": { + "description": "List of attributes.", + "type": "array" }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "attributes": { + "description": "List of attributes.", + "type": "array" }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Category name." }, + "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": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "has_price", - "in": "query", - "description": "Limit result set to products with or without price.", - "required": false, - "schema": {} - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with specified attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { "type": "string", "description": "Attribute slug." }, - "term": { "type": "string", "description": "Attribute term." }, - "terms": { "type": "array", "description": "Attribute terms." } - } - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - } - }, - "/wc-analytics/products/{product_id}/variations/generate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "delete": { "type": "boolean", "description": "Deletes unused variations." }, - "default_values": { "type": "object", "description": "Default values for generated variations." }, - "type": { "type": "string", "description": "Product type." }, - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Stock Keeping Unit." }, - "global_unique_id": { "type": "string", "description": "GTIN, UPC, EAN or ISBN." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "status": { "type": "string", "description": "Variation status." }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at variation level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "stock_status": { "type": "string", "description": "Controls the stock status of the product." }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "low_stock_amount": { - "type": ["integer", "null"], - "description": "Low Stock amount for the variation." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "name": { "type": "string", "description": "Product parent name." }, - "parent_id": { "type": "integer", "description": "Product parent ID." } - } - } - } - } - } - } - }, - "/wc-analytics/variations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Search by similar product name, SKU, or attribute value.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified", "menu_order"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { "enum": ["instock", "outofstock", "onbackorder"] } - }, - { - "name": "has_price", - "in": "query", - "description": "Limit result set to products with or without price.", - "required": false, - "schema": {} - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with specified attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { "type": "string", "description": "Attribute slug." }, - "term": { "type": "string", "description": "Attribute term." }, - "terms": { "type": "array", "description": "Attribute terms." } - } - } - } - } - ] - } - }, - "/wc-analytics/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to reviews published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "product"] } - }, - { - "name": "reviewer", - "in": "query", - "description": "Limit result set to reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_exclude", - "in": "query", - "description": "Ensure result set excludes reviews assigned to specific user IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "reviewer_email", - "in": "query", - "description": "Limit result set to that from a specific author email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to reviews assigned to specific product IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to reviews assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "hold", "approved", "spam", "trash"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "required": true, - "description": "Unique identifier for the product." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "reviewer_email": { "type": "string", "required": true, "description": "Email of the reviewer." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } }, - "required": ["product_id", "reviewer", "reviewer_email", "review"] + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } } }, - "/wc-analytics/products/reviews/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, + "/wc-analytics/products/categories/{id}": { + "delete": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } + "schema": { + "enum": [ + "edit", + "view" + ] } } - } - }, - "put": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" } } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -36591,36 +35142,60 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." + "description": { + "description": "HTML description of the resource.", + "type": "string" }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, + "post": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -36629,2795 +35204,9152 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } + "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" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } } }, - "/wc-analytics/products/reviews/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } + "/wc-analytics/products/count-low-in-stock": { + "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": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] } } - } - }, - "put": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Count Low in Stock Items" } } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product_id": { - "type": "integer", - "description": "Unique identifier for the product that the review belongs to." - }, - "product_name": { "type": "string", "description": "Product name." }, - "status": { "type": "string", "description": "Status of the review." }, - "reviewer": { "type": "string", "description": "Reviewer name." }, - "reviewer_email": { "type": "string", "description": "Reviewer email." }, - "review": { "type": "string", "description": "The content of the review." }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." } - } - } - } + }, + "description": "OK" } } } }, "/wc-analytics/products/low-in-stock": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "status", - "in": "query", "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } - } - ] - } - }, - "/wc-analytics/products/count-low-in-stock": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/Count Low in Stock Items" } } + "schema": { + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ] } } - }, + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/reviews": { + "get": { "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "status", + "description": "Current page of the collection.", "in": "query", - "description": "Limit result set to products assigned a specific status.", + "name": "page", "required": false, - "schema": { "enum": ["draft", "pending", "private", "publish", "future"] } + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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 reviews published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "description": "Ensure result set excludes reviews assigned to specific user IDs.", + "in": "query", + "name": "reviewer_exclude", + "required": false, + "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" + } + }, + { + "description": "Limit result set to reviews assigned to specific product IDs.", + "in": "query", + "name": "product", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to reviews assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } } - ] - } - }, - "/wc-analytics/settings/{group_id}": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc-analytics/settings/{group_id}/batch": { + } + }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "product_id": { + "description": "Unique identifier for the product.", + "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" } - } + }, + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/reviews/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/suggested-products": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to specific product categorie ids.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific product tag ids.", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific amount of suggested products.", + "in": "query", + "name": "limit", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{id}/duplicate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_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": [ + "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": "Search by similar product name, SKU, or attribute value.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit result set to products with or without price.", + "in": "query", + "name": "has_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations/generate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/products/{product_id}/variations/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/categories": { + "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": [ + "category", + "category_id", + "items_sold", + "net_revenue", + "orders_count", + "products_count" + ] + } + }, + { + "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": "Limit result set to items that have the specified order status.", + "in": "query", + "name": "status_is", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that don't have the specified order status.", + "in": "query", + "name": "status_is_not", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each category to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_categories" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/coupons": { + "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": [ + "amount", + "code", + "coupon_id", + "orders_count" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to coupons assigned specific coupon IDs.", + "in": "query", + "name": "coupons", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each coupon to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupons" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/coupons/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": [ + "amount", + "coupons_count", + "date", + "orders_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": [ + "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" + } + } + }, + { + "description": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "schema": { + "enum": [ + "category", + "coupon", + "product", + "variation" + ] + } + }, + { + "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_coupons_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/customers": { + "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": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "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" + } + }, + { + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "customers", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified user IDs.", + "in": "query", + "name": "users", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Filter out results where any of the passed fields are empty", + "in": "query", + "name": "filter_empty", + "required": false, + "schema": { + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/customers/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": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_before", + "required": false, + "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" + } + }, + { + "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 response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "in": "query", + "name": "searchby", + "required": false, + "schema": { + "enum": [ + "all", + "email", + "name", + "username" + ] + } + }, + { + "description": "Limit response to objects with specific names.", + "in": "query", + "name": "name_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific names.", + "in": "query", + "name": "name_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific usernames.", + "in": "query", + "name": "username_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific usernames.", + "in": "query", + "name": "username_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects including emails.", + "in": "query", + "name": "email_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding emails.", + "in": "query", + "name": "email_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with specific countries.", + "in": "query", + "name": "country_includes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects excluding specific countries.", + "in": "query", + "name": "country_excludes", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "in": "query", + "name": "last_active_before", + "required": false, + "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" + } + }, + { + "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" + } + } + }, + { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "in": "query", + "name": "registered_between", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "in": "query", + "name": "orders_count_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "in": "query", + "name": "orders_count_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an order count between two given integers.", + "in": "query", + "name": "orders_count_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "in": "query", + "name": "total_spend_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "in": "query", + "name": "total_spend_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with a total order spend between two given numbers.", + "in": "query", + "name": "total_spend_between", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "in": "query", + "name": "avg_order_value_min", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "in": "query", + "name": "avg_order_value_max", + "required": false, + "schema": {} + }, + { + "description": "Limit response to objects with an average order spend between two given numbers.", + "in": "query", + "name": "avg_order_value_between", + "required": false, + "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" + } + }, + { + "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" + } + }, + { + "description": "Limit result to items with specified customer IDs.", + "in": "query", + "name": "customers", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit stats fields to the specified items.", + "in": "query", + "name": "fields", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/downloads": { + "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": [ + "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" + ] + } + }, + { + "description": "Limit result set to items that have the specified product(s) assigned.", + "in": "query", + "name": "product_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified order IDs.", + "in": "query", + "name": "order_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have the specified user IDs.", + "in": "query", + "name": "customer_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have a specified IP address.", + "in": "query", + "name": "ip_address_includes", + "required": false, + "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" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_downloads" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/downloads/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": [ + "date", + "download_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": [ + "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 set to items that have the specified product(s) assigned.", + "in": "query", + "name": "product_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified order IDs.", + "in": "query", + "name": "order_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have the specified customer IDs.", + "in": "query", + "name": "customer_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to objects that have a specified IP address.", + "in": "query", + "name": "ip_address_includes", + "required": false, + "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" + } + } + }, + { + "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_orders_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import/cancel": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } } }, "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" } } - } + }, + "description": "OK" } } - }, + } + }, + "/wc-analytics/reports/import/delete": { "patch": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import/status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/import/totals": { + "get": { + "parameters": [ + { + "description": "Number of days to import.", + "in": "query", + "name": "days", + "required": false, + "schema": { + "minimum": 0 + } + }, + { + "description": "Skip importing existing order data.", + "in": "query", + "name": "skip_existing", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_import" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/orders": { + "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": 0 + } + }, + { + "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": [ + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified variation(s) assigned.", + "in": "query", + "name": "variation_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified coupon(s) assigned.", + "in": "query", + "name": "coupon_includes", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified order status.", + "in": "query", + "name": "status_is", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that don't have the specified order status.", + "in": "query", + "name": "status_is_not", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to returning or new customers.", + "in": "query", + "name": "customer_type", + "required": false, + "schema": { + "enum": [ + "", + "new", + "returning" + ] + } + }, + { + "description": "Limit result set to specific types of refunds.", + "in": "query", + "name": "refunds", + "required": false, + "schema": { + "enum": [ + "", + "all", + "full", + "none", + "partial" + ] + } + }, + { + "description": "Add additional piece of info about each coupon to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to items that have the specified order IDs.", + "in": "query", + "name": "order_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to orders that include products with the specified attributes.", + "in": "query", + "name": "attribute_is", + "required": false, + "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" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/orders/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": [ + "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": [ + "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 set to items that have the specified order status.", + "in": "query", + "name": "status_is", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that don't have the specified order status.", + "in": "query", + "name": "status_is_not", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to items that have the specified product(s) assigned.", + "in": "query", + "name": "product_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified variation(s) assigned.", + "in": "query", + "name": "variation_includes", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items that have the specified coupon(s) assigned.", + "in": "query", + "name": "coupon_includes", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Alias for customer_type (deprecated).", + "in": "query", + "name": "customer", + "required": false, + "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" + ] + } + }, + { + "description": "Limit result set to specific types of refunds.", + "in": "query", + "name": "refunds", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "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" + } + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_orders_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/performance-indicators": { + "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": "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.", + "in": "query", + "name": "stats", + "required": false, + "schema": { + "items": { + "enum": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "type": "string" + } + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/performance-indicators/allowed": { + "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": "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.", + "in": "query", + "name": "stats", + "required": false, + "schema": { + "items": { + "enum": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "type": "string" + } + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_performance_indicator" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/products": { + "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": [ + "date", + "items_sold", + "net_revenue", + "orders_count", + "product_name", + "sku", + "variations" + ] + } + }, + { + "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 from the specified categories.", + "in": "query", + "name": "categories", + "required": false, + "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" + ] + } + }, + { + "description": "Limit result to items with specified product IDs.", + "in": "query", + "name": "products", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Add additional piece of info about each product to the report.", + "in": "query", + "name": "extended_info", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/products/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": "Limit result to items from the specified categories.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result to items with specified product IDs.", + "in": "query", + "name": "products", + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_products_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/revenue/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", + "gross_sales", + "items_sold", + "net_revenue", + "orders_count", + "refunds", + "shipping", + "taxes", + "total_sales" + ] + } + }, + { + "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": "Segment the response by additional constraint.", + "in": "query", + "name": "segmentby", + "required": false, + "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_completed", + "date_created", + "date_paid" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_revenue_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/stock": { + "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": "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", + "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" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to items assigned a stock report type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "all", + "instock", + "lowstock", + "onbackorder", + "outofstock" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_stock" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/stock/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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customers_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/taxes": { + "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": [ + "name", + "order_tax", + "orders_count", + "rate", + "shipping_tax", + "tax_code", + "tax_rate_id", + "total_tax" + ] + } + }, + { + "description": "Force retrieval of fresh data instead of from the cache.", + "in": "query", + "name": "force_cache_refresh", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to items assigned one or more tax rates.", + "in": "query", + "name": "taxes", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_taxes" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/taxes/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": [ + "date", + "items_sold", + "orders_count", + "products_count", + "total_sales" + ] + } + }, + { + "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": "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": [ + "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" + } + } + }, + { + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_variations_stats" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/reports/{type}/export": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "email": { + "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" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "email": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "type", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "email": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_export_status" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/settings/{group_id}/batch": { + "patch": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/settings/{group_id}/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, { - "name": "id", - "in": "path", + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "group_id", "required": true, "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/taxes": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "description": "Sort collection by object attribute.", + "in": "query", + "name": "orderby", "required": false, - "schema": { "enum": ["id", "order", "priority"] } + "schema": { + "enum": [ + "id", + "order", + "priority" + ] + } }, { - "name": "class", - "in": "query", "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" + ] + } }, { - "name": "search", - "in": "query", "description": "Search by similar tax code.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "include", - "in": "query", "description": "Limit result set to items that have the specified rate ID(s) assigned.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc-analytics/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "include", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "items": { + "type": "integer" + } + } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "type": "string" }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." + "class": { + "description": "Tax class.", + "type": "string" }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." + "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" }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "priority": { + "description": "Tax priority.", + "type": "integer" }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." + "rate": { + "description": "Tax rate.", + "type": "string" }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "state": { + "description": "State code.", + "type": "string" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } } } }, "/wc-analytics/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." - }, - "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." - }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, - "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." - }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { - "type": "string", - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead." + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, "city": { - "type": "string", - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead." + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "type": "string" }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." + "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" }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." }, "postcodes": { - "type": "array", - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3." + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" }, - "cities": { "type": "array", "description": "List of city names. Introduced in WooCommerce 5.3." } - } - } - } - } - } - } - }, - "/wc/store": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/store/batch": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "validation": { "type": "string" }, "requests": { "type": "array", "required": true } }, - "required": ["requests"] - } - } - } - } - } - }, - "/wc/store/cart": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/cart/add-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "The basket item product or variation ID." }, - "quantity": { "type": "integer", "description": "Quantity of this item to add to the basket." }, - "variation": { "type": "array", "description": "Chosen attributes (for variations)." } - } - } - } - } - } - } - }, - "/wc/store/cart/apply-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/cart/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "The coupon's unique code." }, - "discount_type": { - "type": "string", - "description": "The discount type for the coupon (eg percentage or fixed amount)" - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - } - } - }, - "/wc/store/cart/coupons/{code}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/cart/extensions": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "namespace": { - "type": "string", - "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately." + "priority": { + "description": "Tax priority.", + "type": "integer" }, - "data": { "type": "object", "description": "Additional data to pass to the extension" } - } - } - } - } - } - } - }, - "/wc/store/cart/items": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - } - } - }, - "/wc/store/cart/items/{key}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/cart/remove-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/cart/remove-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item." } - } - } - } - } - } - } - }, - "/wc/store/cart/select-shipping-rate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "package_id": { - "type": ["integer", "string", "null"], - "required": false, - "description": "The ID of the package being shipped. Leave blank to apply to all packages." + "rate": { + "description": "Tax rate.", + "type": "string" }, - "rate_id": { - "type": "string", - "required": true, - "description": "The chosen rate ID for the package." + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" } }, - "required": ["rate_id"] + "type": "object" } } } - } - } - }, - "/wc/store/cart/update-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item to update." }, - "quantity": { "type": "integer", "description": "New quantity of the item in the basket." } - } - } - } - } - } - } - }, - "/wc/store/cart/update-customer": { - "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "billing_address": { "type": "object", "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." } - } - } - } - } - } - } - }, - "/wc/store/checkout": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_password": { - "type": "string", - "description": "Customer password for new accounts, if applicable." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "create_account": { - "type": "boolean", - "description": "Whether to create a new user account as part of order processing." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/checkout/{id}": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/order/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/store/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wc/store/products/collection-data": { - "get": { - "responses": { - "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "type": "string" }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" + "class": { + "description": "Tax class.", + "type": "string" }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] + "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" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" } } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - }, - { - "name": "calculate_price_range", - "in": "query", - "description": "If true, calculates the minimum and maximum product prices for the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_stock_status_counts", - "in": "query", - "description": "If true, calculates stock counts for products in the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_attribute_counts", - "in": "query", - "description": "If requested, calculates attribute term counts for products in the collection.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "taxonomy": { - "description": "Taxonomy name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "query_type": { - "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "type": "string", - "enum": ["and", "or"], - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - { - "name": "calculate_rating_counts", - "in": "query", - "description": "If true, calculates rating counts for products in the collection.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } - }, - { - "name": "category_id", - "in": "query", - "description": "Limit result set to reviews from specific category IDs.", - "required": false, - "schema": {} - }, - { - "name": "product_id", - "in": "query", - "description": "Limit result set to reviews from specific product IDs.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] - } - } - } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - } - ] - } - }, - "/wc/store/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/products/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { "name": "slug", "in": "path", "description": "Slug of the resource.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/store/v1/batch": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "validation": { "type": "string" }, "requests": { "type": "array", "required": true } }, - "required": ["requests"] - } - } - } - } - } - }, - "/wc/store/v1/cart": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1/cart/add-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "The basket item product or variation ID." }, - "quantity": { "type": "integer", "description": "Quantity of this item to add to the basket." }, - "variation": { "type": "array", "description": "Chosen attributes (for variations)." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/apply-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "The coupon's unique code." }, - "discount_type": { - "type": "string", - "description": "The discount type for the coupon (eg percentage or fixed amount)" - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - } - } - }, - "/wc/store/v1/cart/coupons/{code}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_coupon" } } } - } - }, - "parameters": [ - { - "name": "code", - "in": "path", - "description": "Unique identifier for the coupon within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/v1/cart/extensions": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart-extensions" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "namespace": { - "type": "string", - "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately." - }, - "data": { "type": "object", "description": "Additional data to pass to the extension" } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/items": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - } - } - }, - "/wc/store/v1/cart/items/{key}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } + }, + "description": "OK" } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } } }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/taxes/{id}": { + "delete": { "parameters": [ { - "name": "key", + "description": "Unique identifier for the resource.", "in": "path", - "description": "Unique identifier for the item within the basket.", + "name": "id", "required": true, "schema": {} } @@ -39425,1491 +44357,904 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, "parameters": [ { - "name": "key", + "description": "Unique identifier for the resource.", "in": "path", - "description": "Unique identifier for the item within the basket.", + "name": "id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { "type": "object", "properties": { "extensions": { "type": "object" } } } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart_item" } } } - } - }, - "parameters": [ - { - "name": "key", - "in": "path", - "description": "Unique identifier for the item within the basket.", - "required": true, - "schema": {} - } - ] - } - }, - "/wc/store/v1/cart/remove-coupon": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Unique identifier for the coupon within the basket." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/remove-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/select-shipping-rate": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "package_id": { - "type": ["integer", "string", "null"], - "required": false, - "description": "The ID of the package being shipped. Leave blank to apply to all packages." + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "type": "array" }, - "rate_id": { - "type": "string", - "required": true, - "description": "The chosen rate ID for the package." + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" } }, - "required": ["rate_id"] + "type": "object" } } } - } - } - }, - "/wc/store/v1/cart/update-item": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "key": { "type": "string", "description": "Unique identifier (key) for the basket item to update." }, - "quantity": { "type": "integer", "description": "New quantity of the item in the basket." } - } - } - } - } - } - } - }, - "/wc/store/v1/cart/update-customer": { - "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cart" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "billing_address": { "type": "object", "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." } - } - } - } - } - } - } - }, - "/wc/store/v1/checkout": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_password": { - "type": "string", - "description": "Customer password for new accounts, if applicable." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "create_account": { - "type": "boolean", - "description": "Whether to create a new user account as part of order processing." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/v1/checkout/{id}": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkout-order" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "payment_data": { - "type": "array", - "description": "Data to pass through to the payment method when processing payment." - }, - "customer_note": { - "type": "string", - "description": "Note added to the order by the customer during checkout." - }, - "billing_address": { "type": "object", "required": true, "description": "Billing address." }, - "shipping_address": { "type": "object", "description": "Shipping address." }, - "payment_method": { - "type": "string", - "description": "The ID of the payment method being used to process the payment." - }, - "additional_fields": { - "type": "object", - "description": "Additional fields to be persisted on the order." - }, - "extensions": { "type": "object" } - }, - "required": ["billing_address"] - } - } - } - } - } - }, - "/wc/store/v1/order/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wc/store/v1/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/store/v1/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count", "menu_order", "name_num", "id"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wc/store/v1/products/collection-data": { - "get": { - "responses": { - "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product-collection-data" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" } } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - }, - { - "name": "calculate_price_range", - "in": "query", - "description": "If true, calculates the minimum and maximum product prices for the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_stock_status_counts", - "in": "query", - "description": "If true, calculates stock counts for products in the collection.", - "required": false, - "schema": {} - }, - { - "name": "calculate_attribute_counts", - "in": "query", - "description": "If requested, calculates attribute term counts for products in the collection.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "taxonomy": { - "description": "Taxonomy name.", - "type": "string", - "context": ["view", "edit"], - "readonly": true - }, - "query_type": { - "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "type": "string", - "enum": ["and", "or"], - "context": ["view", "edit"], - "readonly": true - } - } - } - } - }, - { - "name": "calculate_rating_counts", - "in": "query", - "description": "If true, calculates rating counts for products in the collection.", - "required": false, - "schema": {} + }, + "description": "OK" } - ] - } - }, - "/wc/store/v1/products/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, + } + }, + "post": { "parameters": [ { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "rating", "product"] } - }, - { - "name": "category_id", - "in": "query", - "description": "Limit result set to reviews from specific category IDs.", - "required": false, - "schema": {} - }, - { - "name": "product_id", - "in": "query", - "description": "Limit result set to reviews from specific product IDs.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/term" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Sort ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort by term property.", - "required": false, - "schema": { "enum": ["name", "slug", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "If true, empty terms will not be returned.", - "required": false, - "schema": {} - } - ] - } - }, - "/wc/store/v1/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "required": false, - "schema": { "minimum": 0, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "date_column", - "in": "query", - "description": "When limiting response using after/before, which date column to compare against.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "modified", "modified_gmt"] } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable", "variation"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "required": false, - "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "category_operator", - "in": "query", - "description": "Operator to compare product category terms.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "tag_operator", - "in": "query", - "description": "Operator to compare product tags.", - "required": false, - "schema": { "enum": ["in", "not_in", "and"] } - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "required": false, - "schema": {} - }, - { - "name": "stock_status", - "in": "query", - "description": "Limit result set to products with specified stock status.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": ["instock", "outofstock", "onbackorder"], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - } - } - }, - { - "name": "attributes", - "in": "query", - "description": "Limit result set to products with selected global attributes.", - "required": false, - "schema": { - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { "type": "integer" }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { "type": "string" }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": ["in", "not_in", "and"] - } - } - } - } - }, - { - "name": "attribute_relation", - "in": "query", - "description": "The logical relationship between attributes when filtering across several at once.", - "required": false, - "schema": { "enum": ["in", "and"] } - }, - { - "name": "catalog_visibility", - "in": "query", - "description": "Determines if hidden or visible catalogue products are shown.", - "required": false, - "schema": { "enum": ["any", "visible", "catalog", "search", "hidden"] } - }, - { - "name": "rating", - "in": "query", - "description": "Limit result set to products with a certain average rating.", - "required": false, - "schema": { "items": { "type": "integer", "enum": [1, 2, 3, 4, 5] } } - } - ] - } - }, - "/wc/store/v1/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } } - ] - } - }, - "/wc/store/v1/products/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } } }, - "parameters": [ - { "name": "slug", "in": "path", "description": "Slug of the resource.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" } - ] + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-analytics/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": "Search by similar product name, SKU, or attribute value.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit result set to products with or without price.", + "in": "query", + "name": "has_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc-telemetry": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc-telemetry/tracker": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "installation_date": { + "description": "Installation date of the WooCommerce mobile app.", + "required": false, + "type": "string" + }, + "platform": { + "description": "Platform to track.", + "required": true, + "type": "string" + }, + "version": { + "description": "Platform version to track.", + "required": true, + "type": "string" + } + }, + "required": [ + "platform", + "version" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/private": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/private/ai/store-title": { - "post": { + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-title" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - } - } - } - } - } - } - } - }, - "/wc/private/ai/images": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/images" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - } - } - } - } - } - } - } - }, - "/wc/private/ai/patterns": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - }, - "images": { "type": "object", "description": "The images for a given store." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/patterns" } } } - } - } - } - }, - "/wc/private/ai/product": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "products_information": { - "type": "object", - "description": "Data generated by AI for updating dummy products." - }, - "last_product": { - "type": "boolean", - "description": "Whether the product being updated is the last one in the loop" - } - } - } - } - } - } - } - }, - "/wc/private/ai/products": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "business_description": { - "type": "string", - "description": "The business description for a given store." - }, - "images": { "type": "object", "description": "The images for a given store." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/products" } } } + "description": "OK" } } } }, "/wc/private/ai/business-description": { "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/ai/business-description" } } - } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { "business_description": { - "type": "string", - "description": "The business description for a given store." + "description": "The business description for a given store.", + "type": "string" } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/business-description" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/images": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/images" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/patterns": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + }, + "images": { + "description": "The images for a given store.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/patterns" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/product": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "last_product": { + "description": "Whether the product being updated is the last one in the loop", + "type": "boolean" + }, + "products_information": { + "description": "Data generated by AI for updating dummy products.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/products": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + }, + "images": { + "description": "The images for a given store.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/products" + } + } + }, + "description": "OK" + } } } }, @@ -40917,8 +45262,45 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai/store-info" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-info" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/private/ai/store-title": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "business_description": { + "description": "The business description for a given store.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ai/store-title" + } + } + }, + "description": "OK" } } } @@ -40927,10982 +45309,5349 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, + "description": "OK" } } }, "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patterns" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/patterns" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/batch": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/cart": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/add-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/apply-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/coupons": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/coupons/{code}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/extensions": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/items": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/items/{key}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/remove-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/remove-item": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/select-shipping-rate": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "package_id": { + "description": "The ID of the package being shipped. Leave blank to apply to all packages.", + "required": false, + "type": [ + "integer", + "null", + "string" + ] + }, + "rate_id": { + "description": "The chosen rate ID for the package.", + "required": true, + "type": "string" + } + }, + "required": [ + "rate_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/update-customer": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/cart/update-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/checkout": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "customer_password": { + "description": "Customer password for new accounts, if applicable.", + "type": "string" + }, + "extensions": { + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/checkout/{id}": { + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/order/{id}": { + "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": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute.", + "in": "path", + "name": "attribute_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": [ + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/attributes/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/categories": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/categories/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/collection-data": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + }, + { + "description": "If true, calculates the minimum and maximum product prices for the collection.", + "in": "query", + "name": "calculate_price_range", + "required": false, + "schema": {} + }, + { + "description": "If true, calculates stock counts for products in the collection.", + "in": "query", + "name": "calculate_stock_status_counts", + "required": false, + "schema": {} + }, + { + "description": "If requested, calculates attribute term counts for products in the collection.", + "in": "query", + "name": "calculate_attribute_counts", + "required": false, + "schema": { + "items": { + "properties": { + "query_type": { + "context": [ + "edit", + "view" + ], + "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", + "enum": [ + "and", + "or" + ], + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomy name.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + } + }, + { + "description": "If true, calculates rating counts for products in the collection.", + "in": "query", + "name": "calculate_rating_counts", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/reviews": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "date_gmt", + "id", + "product", + "rating" + ] + } + }, + { + "description": "Limit result set to reviews from specific category IDs.", + "in": "query", + "name": "category_id", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to reviews from specific product IDs.", + "in": "query", + "name": "product_id", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/tags": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/products/{slug}": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/v1/batch": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "requests": { + "required": true, + "type": "array" + }, + "validation": { + "type": "string" + } + }, + "required": [ + "requests" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/add-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/apply-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/coupons": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/coupons/{code}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the coupon within the basket.", + "in": "path", + "name": "code", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/extensions": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart-extensions" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/items": { + "delete": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/items/{key}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the item within the basket.", + "in": "path", + "name": "key", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "extensions": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/remove-coupon": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/remove-item": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "key": { + "description": "Unique identifier (key) for the basket item.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/select-shipping-rate": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "package_id": { + "description": "The ID of the package being shipped. Leave blank to apply to all packages.", + "required": false, + "type": [ + "integer", + "null", + "string" + ] + }, + "rate_id": { + "description": "The chosen rate ID for the package.", + "required": true, + "type": "string" + } + }, + "required": [ + "rate_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/update-customer": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "billing_address": { + "description": "Billing address.", + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/cart/update-item": { + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cart" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/checkout": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "type": "string" + }, + "customer_password": { + "description": "Customer password for new accounts, if applicable.", + "type": "string" + }, + "extensions": { + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/checkout/{id}": { + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "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" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "type": "object" + } + }, + "required": [ + "billing_address" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/checkout-order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/order/{id}": { + "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": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute.", + "in": "path", + "name": "attribute_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": [ + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/attributes/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/categories": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/categories/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/collection-data": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specific slug(s). Use commas to separate.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "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" + ] + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products assigned a specific type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product category terms.", + "in": "query", + "name": "category_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Operator to compare product tags.", + "in": "query", + "name": "tag_operator", + "required": false, + "schema": { + "enum": [ + "and", + "in", + "not_in" + ] + } + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + } + } + }, + { + "description": "Limit result set to products with selected global attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + } + } + }, + { + "description": "The logical relationship between attributes when filtering across several at once.", + "in": "query", + "name": "attribute_relation", + "required": false, + "schema": { + "enum": [ + "and", + "in" + ] + } + }, + { + "description": "Determines if hidden or visible catalogue products are shown.", + "in": "query", + "name": "catalog_visibility", + "required": false, + "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" + } + } + }, + { + "description": "If true, calculates the minimum and maximum product prices for the collection.", + "in": "query", + "name": "calculate_price_range", + "required": false, + "schema": {} + }, + { + "description": "If true, calculates stock counts for products in the collection.", + "in": "query", + "name": "calculate_stock_status_counts", + "required": false, + "schema": {} + }, + { + "description": "If requested, calculates attribute term counts for products in the collection.", + "in": "query", + "name": "calculate_attribute_counts", + "required": false, + "schema": { + "items": { + "properties": { + "query_type": { + "context": [ + "edit", + "view" + ], + "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", + "enum": [ + "and", + "or" + ], + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomy name.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + } + } + }, + { + "description": "If true, calculates rating counts for products in the collection.", + "in": "query", + "name": "calculate_rating_counts", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-collection-data" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/reviews": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "date_gmt", + "id", + "product", + "rating" + ] + } + }, + { + "description": "Limit result set to reviews from specific category IDs.", + "in": "query", + "name": "category_id", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to reviews from specific product IDs.", + "in": "query", + "name": "product_id", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/tags": { + "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. Defaults to no limit if left blank.", + "in": "query", + "name": "per_page", + "required": false, + "schema": { + "maximum": 100, + "minimum": 0 + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Sort ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort by term property.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "name", + "slug" + ] + } + }, + { + "description": "If true, empty terms will not be returned.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/store/v1/products/{slug}": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" } } } }, "/wc/v1": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wc/v1/coupons": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", - "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "code", - "in": "query", - "description": "Limit result set to resources with a specific code.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - }, - "required": ["code"] - } - } - } - } - } - }, - "/wc/v1/coupons/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "description": { "type": "string", "description": "Coupon description." }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "expiry_date": { "type": ["null", "string"], "description": "UTC DateTime when the coupon expires." }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "exclude_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - } - } - } - } - } - } - } - }, - "/wc/v1/customers/{customer_id}/downloads": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } } - } - }, - "parameters": [ - { - "name": "customer_id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v1/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } - }, - { - "name": "email", - "in": "query", - "description": "Limit result set to resources with a specific email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "role", - "in": "query", - "description": "Limit result set to resources with a specific role.", "required": false, "schema": { "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "required": true, "description": "New user email address." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "required": false, "description": "New user username." }, - "password": { "type": "string", "required": true, "description": "New user password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - }, - "required": ["email", "password"] - } - } - } - } - } - }, - "/wc/v1/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - }, - "reassign": { "type": "integer", "description": "ID to reassign posts to." } - } - } - } - } - } - } - }, - "/wc/v1/customers/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." } - } - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/notes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "note": { "type": "string", "required": true, "description": "Order note content." }, - "customer_note": { - "type": "boolean", - "description": "Shows/define if the note is only for reference or for the customer (the user will be notified)." - } - }, - "required": ["note"] - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/notes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", - "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders assigned a specific status.", - "required": false, - "schema": { - "enum": [ - "any", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "edit", + "view" ] } }, { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "amount": { "type": "string", "description": "Refund amount." }, - "reason": { "type": "string", "description": "Reason for refund." } - } - } - } - } - } - } - }, - "/wc/v1/orders/{order_id}/refunds/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", - "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders assigned a specific status.", + "name": "order", "required": false, "schema": { "enum": [ - "any", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" + "asc", + "desc" ] } }, { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - } - }, - "/wc/v1/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - } - }, - "/wc/v1/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products/{product_id}/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "query", - "description": "Unique identifier for the variation.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "Unique identifier for the variation." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "email": { "type": "string", "required": true, "description": "Email of the reviewer." } - }, - "required": ["review", "name", "email"] - } - } - } - } - } - }, - "/wc/v1/products/{product_id}/reviews/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/products/shipping_classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/shipping_classes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/shipping_classes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/products/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/products/tags/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v1/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "filter", "in": "query", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with a specific SKU.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - } - }, - "/wc/v1/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v1/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { "type": "string", "description": "Start date of sale price." }, - "date_on_sale_to": { "type": "string", "description": "End data of sale price." }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "download_type": { - "type": "string", - "description": "Download type, this controls the schema on the front-end." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "variations": { "type": "array", "description": "List of variations." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." } - } - } - } - } - } - } - }, - "/wc/v1/reports/sales": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v1/reports/top_sellers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "period", - "in": "query", - "description": "Report period.", - "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } - }, - { - "name": "date_min", - "in": "query", - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - }, - { - "name": "date_max", - "in": "query", - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "required": false, - "schema": { "format": "date" } - } - ] - } - }, - "/wc/v1/reports": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v1/taxes/classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "name": { "type": "string", "required": true, "description": "Tax class name." } }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v1/taxes/classes/{slug}": { - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "order", "priority"] } - }, - { - "name": "class", - "in": "query", - "description": "Sort by tax class.", - "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v1/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v1/webhooks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "title"] } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to webhooks assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "required": true, "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - }, - "delivery_url": { "type": "string", "required": true, "description": "Webhook delivery URL." } - }, - "required": ["topic", "delivery_url"] - } - } - } - } - } - }, - "/wc/v1/webhooks/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v1/webhooks/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - } - }, - "/wc/v1/webhooks/{webhook_id}/deliveries": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v1/webhooks/{webhook_id}/deliveries/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc/v2/coupons": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "code", - "in": "query", - "description": "Limit result set to resources with a specific code.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "required": true, "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["code"] - } - } - } - } - } - }, - "/wc/v2/coupons/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_coupon" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/coupons/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Coupon code." }, - "amount": { - "type": "string", - "description": "The amount of discount. Should always be numeric, even if setting a percentage." - }, - "status": { - "type": "string", - "description": "The status of the coupon. Should always be draft, published, or pending review" - }, - "discount_type": { - "type": "string", - "description": "Determines the type of discount that will be applied." - }, - "description": { "type": "string", "description": "Coupon description." }, - "date_expires": { - "type": ["null", "string"], - "description": "The date the coupon expires, in the site's timezone." - }, - "date_expires_gmt": { - "type": ["null", "string"], - "description": "The date the coupon expires, as GMT." - }, - "individual_use": { - "type": "boolean", - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket." - }, - "product_ids": { "type": "array", "description": "List of product IDs the coupon can be used on." }, - "excluded_product_ids": { - "type": "array", - "description": "List of product IDs the coupon cannot be used on." - }, - "usage_limit": { - "type": "integer", - "description": "How many times the coupon can be used in total." - }, - "usage_limit_per_user": { - "type": "integer", - "description": "How many times the coupon can be used per customer." - }, - "limit_usage_to_x_items": { - "type": "integer", - "description": "Max number of items in the basket the coupon can be applied to." - }, - "free_shipping": { - "type": "boolean", - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping." - }, - "product_categories": { - "type": "array", - "description": "List of category IDs the coupon applies to." - }, - "excluded_product_categories": { - "type": "array", - "description": "List of category IDs the coupon does not apply to." - }, - "exclude_sale_items": { - "type": "boolean", - "description": "If true, this coupon will not be applied to items that have sale prices." - }, - "minimum_amount": { - "type": "string", - "description": "Minimum order amount that needs to be in the basket before coupon applies." - }, - "maximum_amount": { - "type": "string", - "description": "Maximum order amount allowed when using the coupon." - }, - "email_restrictions": { - "type": "array", - "description": "List of email addresses that can use this coupon." - }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v2/customers/{customer_id}/downloads": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer_download" } } } - } - }, - "parameters": [ - { - "name": "customer_id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v2/customers": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date"] } - }, - { - "name": "email", - "in": "query", - "description": "Limit result set to resources with a specific email.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "role", - "in": "query", - "description": "Limit result set to resources with a specific role.", - "required": false, - "schema": { - "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "required": true, "description": "New user email address." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "required": false, "description": "New user username." }, - "password": { "type": "string", "required": true, "description": "New user password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - }, - "required": ["email", "password"] - } - } - } - } - } - }, - "/wc/v2/customers/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - }, - "reassign": { "type": "integer", "description": "ID to reassign posts to." } - } - } - } - } - } - } - }, - "/wc/v2/customers/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "email": { "type": "string", "description": "The email address for the customer." }, - "first_name": { "type": "string", "description": "Customer first name." }, - "last_name": { "type": "string", "description": "Customer last name." }, - "username": { "type": "string", "description": "Customer login name." }, - "password": { "type": "string", "description": "Customer password." }, - "billing": { "type": "object", "description": "List of billing address data." }, - "shipping": { "type": "object", "description": "List of shipping address data." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/notes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result to customers or internal notes.", - "required": false, - "schema": { "enum": ["any", "customer", "internal"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "note": { "type": "string", "required": true, "description": "Order note content." }, - "customer_note": { - "type": "boolean", - "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." - } - }, - "required": ["note"] - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/notes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/order_note" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/refunds": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "amount": { "type": "string", "description": "Refund amount." }, - "reason": { "type": "string", "description": "Reason for refund." }, - "refunded_by": { "type": "integer", "description": "User ID of user who created the refund." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "api_refund": { - "type": "boolean", - "description": "When true, the payment gateway API is used to generate the refund." - } - } - } - } - } - } - } - }, - "/wc/v2/orders/{order_id}/refunds/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order_refund" } } } - } - }, - "parameters": [ - { "name": "order_id", "in": "path", "description": "The order ID.", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/orders": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "title", "slug", "modified"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to orders assigned a specific status.", - "required": false, - "schema": { - "enum": [ - "any", - "trash", - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ] - } - }, - { - "name": "customer", - "in": "query", - "description": "Limit result set to orders assigned a specific customer.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to orders assigned a specific product.", - "required": false, - "schema": {} - }, - { - "name": "dp", - "in": "query", - "description": "Number of decimal points to use in each resource.", - "required": false, - "schema": {} - }, - { - "name": "order_item_display_meta", - "in": "query", - "description": "Only show meta which is meant to be displayed for an order.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - } - }, - "/wc/v2/orders/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shop_order" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/orders/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent_id": { "type": "integer", "description": "Parent order ID." }, - "status": { "type": "string", "description": "Order status." }, - "currency": { - "type": "string", - "description": "Currency the order was created with, in ISO format." - }, - "customer_id": { "type": "integer", "description": "User ID who owns the order. 0 for guests." }, - "customer_note": { "type": "string", "description": "Note left by customer during checkout." }, - "billing": { "type": "object", "description": "Billing address." }, - "shipping": { "type": "object", "description": "Shipping address." }, - "payment_method": { "type": "string", "description": "Payment method ID." }, - "payment_method_title": { "type": "string", "description": "Payment method title." }, - "transaction_id": { "type": "string", "description": "Unique transaction ID." }, - "meta_data": { "type": "array", "description": "Meta data." }, - "line_items": { "type": "array", "description": "Line items data." }, - "shipping_lines": { "type": "array", "description": "Shipping lines data." }, - "fee_lines": { "type": "array", "description": "Fee lines data." }, - "coupon_lines": { "type": "array", "description": "Coupons line data." }, - "set_paid": { - "type": "boolean", - "description": "Define if the order is paid. It will set the status to processing and reduce stock items." - } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes/{attribute_id}/terms": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/attributes/{attribute_id}/terms/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute_term" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes/{attribute_id}/terms/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "attribute_id", - "in": "path", - "description": "Unique identifier for the attribute of the terms.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Term name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/attributes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_attribute" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/attributes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Attribute name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "type": { "type": "string", "description": "Type of attribute." }, - "order_by": { "type": "string", "description": "Default sort order." }, - "has_archives": { "type": "boolean", "description": "Enable/Disable attribute archives." } - } - } - } - } - } - } - }, - "/wc/v2/products/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/categories/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Category name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the resource." }, - "description": { "type": "string", "description": "HTML description of the resource." }, - "display": { "type": "string", "description": "Category archive display type." }, - "image": { "type": "object", "description": "Image data." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/reviews": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "query", - "description": "Unique identifier for the variation.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "integer", "description": "Unique identifier for the variation." }, - "review": { "type": "string", "required": true, "description": "Review content." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "required": true, "description": "Name of the reviewer." }, - "email": { "type": "string", "required": true, "description": "Email of the reviewer." } - }, - "required": ["review", "name", "email"] - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/reviews/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_review" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/reviews/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "review": { "type": "string", "description": "The content of the review." }, - "date_created": { - "type": ["null", "string"], - "description": "The date the review was created, in the site's timezone." - }, - "date_created_gmt": { - "type": ["null", "string"], - "description": "The date the review was created, as GMT." - }, - "rating": { "type": "integer", "description": "Review rating (0 to 5)." }, - "name": { "type": "string", "description": "Reviewer name." }, - "email": { "type": "string", "description": "Reviewer email." } - } - } - } - } - } - } - }, - "/wc/v2/products/shipping_classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/shipping_classes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/product_shipping_class" } } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/shipping_classes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping class name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by resource attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "slug", "term_group", "description", "count"] } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide resources not assigned to any products.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "required": false, - "schema": {} - }, - { - "name": "product", - "in": "query", - "description": "Limit result set to resources assigned to a specific product.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to resources with a specific slug.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "Name for the resource." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/products/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/products/tags/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tag name." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the resource unique to its type." - }, - "description": { "type": "string", "description": "HTML description of the resource." } - } - } - } - } - } - } - }, - "/wc/v2/products": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "dates_are_gmt", - "in": "query", - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", "required": false, "schema": { "enum": [ "date", "id", "include", - "title", - "slug", "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" + "slug", + "title" ] } }, { - "name": "parent", + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", "in": "query", - "description": "Limit result set to those of particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to products with a specific slug.", + "name": "filter", "required": false, "schema": {} }, { - "name": "status", + "description": "Limit result set to resources with a specific code.", "in": "query", - "description": "Limit result set to products assigned a specific status.", - "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to products assigned a specific type.", - "required": false, - "schema": { "enum": ["simple", "grouped", "external", "variable"] } - }, - { - "name": "sku", - "in": "query", - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "name": "code", "required": false, "schema": {} - }, - { - "name": "featured", - "in": "query", - "description": "Limit result set to featured products.", - "required": false, - "schema": {} - }, - { - "name": "category", - "in": "query", - "description": "Limit result set to products assigned a specific category ID.", - "required": false, - "schema": {} - }, - { - "name": "tag", - "in": "query", - "description": "Limit result set to products assigned a specific tag ID.", - "required": false, - "schema": {} - }, - { - "name": "shipping_class", - "in": "query", - "description": "Limit result set to products assigned a specific shipping class ID.", - "required": false, - "schema": {} - }, - { - "name": "attribute", - "in": "query", - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "required": false, - "schema": {} - }, - { - "name": "attribute_term", - "in": "query", - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "required": false, - "schema": {} - }, - { - "name": "in_stock", - "in": "query", - "description": "Limit result set to products in stock or out of stock.", - "required": false, - "schema": {} - }, - { - "name": "on_sale", - "in": "query", - "description": "Limit result set to products on sale.", - "required": false, - "schema": {} - }, - { - "name": "min_price", - "in": "query", - "description": "Limit result set to products based on a minimum price.", - "required": false, - "schema": {} - }, - { - "name": "max_price", - "in": "query", - "description": "Limit result set to products based on a maximum price.", - "required": false, - "schema": {} - }, - { - "name": "include_meta", - "in": "query", - "description": "Limit meta_data to specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "exclude_meta", - "in": "query", - "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } } - ] - }, - "post": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" } - }, + } + }, + "post": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": { + "description": "Coupon description.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } } }, - "/wc/v2/products/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], + "/wc/v1/coupons/batch": { + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "code": { + "description": "Coupon code.", + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": { + "description": "Coupon description.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } } }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/coupons/{id}": { + "delete": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -51911,107 +50660,71 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -52020,107 +50733,107 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "code": { + "description": "Coupon code.", + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": { + "description": "Coupon description.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "type": [ + "null", + "string" + ] }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, + "post": { "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -52129,697 +50842,17741 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "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" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "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" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "type": "string" + }, + "product_categories": { + "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" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "include", + "name", + "registered_date" + ] + } + }, + { + "description": "Limit result set to resources with a specific email.", + "in": "query", + "name": "email", + "required": false, + "schema": { + "format": "email" + } + }, + { + "description": "Limit result set to resources with a specific role.", + "in": "query", + "name": "role", + "required": false, + "schema": { + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "email", + "password" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers/batch": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers/{customer_id}/downloads": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "customer_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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/customers/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "in": "query", + "name": "filter", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ] + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/notes": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "customer_note": { + "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" + } + }, + "required": [ + "note" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/notes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/refunds": { + "get": { + "parameters": [ + { + "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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "in": "query", + "name": "filter", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ] + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "Refund amount.", + "type": "string" + }, + "reason": { + "description": "Reason for refund.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/orders/{order_id}/refunds/{id}": { + "delete": { + "parameters": [ + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "in": "query", + "name": "filter", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific SKU.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/categories/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/shipping_classes": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/shipping_classes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/shipping_classes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/tags": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/tags/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "download_type": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/{product_id}/reviews": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "query", + "name": "id", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "required": [ + "email", + "name", + "review" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/products/{product_id}/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/reports/sales": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/reports/top_sellers": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes": { + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "order", + "priority" + ] + } + }, + { + "description": "Sort by tax class.", + "in": "query", + "name": "class", + "required": false, + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/classes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/classes/{slug}": { + "delete": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/taxes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "title" + ] + } + }, + { + "description": "Limit result set to webhooks assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "delivery_url", + "topic" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/{webhook_id}/deliveries": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v1/webhooks/{webhook_id}/deliveries/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v2/coupons": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to resources with a specific code.", + "in": "query", + "name": "code", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "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" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/coupons/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/coupons/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "include", + "name", + "registered_date" + ] + } + }, + { + "description": "Limit result set to resources with a specific email.", + "in": "query", + "name": "email", + "required": false, + "schema": { + "format": "email" + } + }, + { + "description": "Limit result set to resources with a specific role.", + "in": "query", + "name": "role", + "required": false, + "schema": { + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "email", + "password" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers/batch": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers/{customer_id}/downloads": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "customer_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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/customers/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to orders assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ] + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/notes": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "view" + ] + } + }, + { + "description": "Limit result to customers or internal notes.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "customer_note": { + "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" + } + }, + "required": [ + "note" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/notes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/refunds": { + "get": { + "parameters": [ + { + "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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/orders/{order_id}/refunds/{id}": { + "delete": { + "parameters": [ + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/payment_gateways": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/payment_gateways/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/products/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" }, "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "description": "Allow one item to be bought in a single order.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "status": { + "description": "Product status (post status).", + "type": "string" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" }, "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." + "description": "Allow one item to be bought in a single order.", + "type": "boolean" }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." + "status": { + "description": "Product status (post status).", + "type": "string" }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/categories/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Product name." }, - "slug": { "type": "string", "description": "Product slug." }, - "type": { "type": "string", "description": "Product type." }, - "status": { "type": "string", "description": "Product status (post status)." }, - "featured": { "type": "boolean", "description": "Featured product." }, - "catalog_visibility": { "type": "string", "description": "Catalogue visibility." }, - "description": { "type": "string", "description": "Product description." }, - "short_description": { "type": "string", "description": "Product short description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Product regular price." }, - "sale_price": { "type": "string", "description": "Product sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "description": { + "description": "HTML description of the resource.", + "type": "string" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "display": { + "description": "Category archive display type.", + "type": "string" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "image": { + "description": "Image data.", + "type": "object" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "type": "integer" }, - "virtual": { "type": "boolean", "description": "If the product is virtual." }, - "downloadable": { "type": "boolean", "description": "If the product is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "name": { + "description": "Category name.", + "type": "string" }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "parent": { + "description": "The ID for the parent of the resource.", + "type": "integer" }, - "external_url": { - "type": "string", - "description": "Product external URL. Only for external products." - }, - "button_text": { - "type": "string", - "description": "Product external button text. Only for external products." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { "type": "boolean", "description": "Stock management at product level." }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "sold_individually": { - "type": "boolean", - "description": "Allow one item to be bought in a single order." - }, - "weight": { "type": "string", "description": "Product weight (kg)." }, - "dimensions": { "type": "object", "description": "Product dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "reviews_allowed": { "type": "boolean", "description": "Allow reviews." }, - "upsell_ids": { "type": "array", "description": "List of up-sell products IDs." }, - "cross_sell_ids": { "type": "array", "description": "List of cross-sell products IDs." }, - "parent_id": { "type": "integer", "description": "Product parent ID." }, - "purchase_note": { - "type": "string", - "description": "Optional note to send the customer after purchase." - }, - "categories": { "type": "array", "description": "List of categories." }, - "tags": { "type": "array", "description": "List of tags." }, - "images": { "type": "array", "description": "List of images." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "default_attributes": { "type": "array", "description": "Defaults variation attributes." }, - "grouped_products": { "type": "array", "description": "List of grouped products ID." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/shipping_classes": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/shipping_classes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/shipping_classes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/tags": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/tags/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/reviews": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "query", + "name": "id", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "required": [ + "email", + "name", + "review" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/reviews/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/products/{product_id}/variations": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "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" + ] + } }, { - "name": "page", - "in": "query", "description": "Current page of the collection.", + "in": "query", + "name": "page", "required": false, - "schema": { "minimum": 1 } + "schema": { + "minimum": 1 + } }, { - "name": "per_page", - "in": "query", "description": "Maximum number of items to be returned in result set.", + "in": "query", + "name": "per_page", "required": false, - "schema": { "minimum": 1, "maximum": 100 } + "schema": { + "maximum": 100, + "minimum": 1 + } }, { - "name": "search", - "in": "query", "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", "required": false, "schema": {} }, { - "name": "after", - "in": "query", "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" + } }, { - "name": "before", - "in": "query", "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" + } }, { - "name": "modified_after", - "in": "query", "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" + } }, { - "name": "modified_before", - "in": "query", "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" + } }, { - "name": "dates_are_gmt", - "in": "query", "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", "required": false, "schema": {} }, { - "name": "exclude", - "in": "query", "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "include", - "in": "query", "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "offset", - "in": "query", "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", "required": false, "schema": {} }, { - "name": "order", - "in": "query", "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", "required": false, - "schema": { "enum": ["asc", "desc"] } + "schema": { + "enum": [ + "asc", + "desc" + ] + } }, { - "name": "orderby", - "in": "query", "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" + ] + } }, { - "name": "parent", - "in": "query", "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", "required": false, - "schema": { "items": { "type": "integer" } } + "schema": { + "items": { + "type": "integer" + } + } }, { - "name": "parent_exclude", - "in": "query", "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" + } + } }, { - "name": "slug", - "in": "query", "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", "required": false, "schema": {} }, { - "name": "status", - "in": "query", "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", "required": false, - "schema": { "enum": ["any", "future", "trash", "draft", "pending", "private", "publish"] } + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } }, { - "name": "type", - "in": "query", "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" + ] + } }, { - "name": "sku", - "in": "query", "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", "required": false, "schema": {} }, { - "name": "featured", - "in": "query", "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", "required": false, "schema": {} }, { - "name": "category", - "in": "query", "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", "required": false, "schema": {} }, { - "name": "tag", - "in": "query", "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", "required": false, "schema": {} }, { - "name": "shipping_class", - "in": "query", "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", "required": false, "schema": {} }, { - "name": "attribute", - "in": "query", "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", "required": false, "schema": {} }, { - "name": "attribute_term", - "in": "query", "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", "required": false, "schema": {} }, { - "name": "in_stock", - "in": "query", "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", "required": false, "schema": {} }, { - "name": "on_sale", - "in": "query", "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", "required": false, "schema": {} }, { - "name": "min_price", - "in": "query", "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", "required": false, "schema": {} }, { - "name": "max_price", - "in": "query", "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", "required": false, "schema": {} }, { - "name": "include_meta", - "in": "query", "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", "required": false, - "schema": { "items": { "type": "string" } } + "schema": { + "items": { + "type": "string" + } + } }, { - "name": "exclude_meta", - "in": "query", "description": "Ensure meta_data excludes specific keys.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - } - }, - "/wc/v2/products/{product_id}/variations/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - }, - { - "name": "context", "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", + "name": "exclude_meta", "required": false, - "schema": { "enum": ["view", "edit"] } + "schema": { + "items": { + "type": "string" + } + } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", "in": "path", - "description": "Unique identifier for the variation.", + "name": "product_id", "required": true, "schema": {} } @@ -52828,305 +68585,162 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] }, "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] }, "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." + "description": { + "description": "Variation description.", + "type": "string" }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." + "dimensions": { + "description": "Variation dimensions.", + "type": "object" }, "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." + "description": "Number of days until access to downloadable files expires.", + "type": "integer" }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." + "download_limit": { + "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" }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", + "type": "boolean" }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "manage_stock": { + "description": "Stock management at variation level.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } - }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." + "menu_order": { + "description": "Menu order, used to custom sort products.", + "type": "integer" }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." + "meta_data": { + "description": "Meta data.", + "type": "array" }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." + "regular_price": { + "description": "Variation regular price.", + "type": "string" }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." + "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": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." - }, - "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." - }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_variation" } } } - } }, - "parameters": [ - { - "name": "product_id", - "in": "path", - "description": "Unique identifier for the variable product.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the variation.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" } } - } + }, + "description": "OK" } } } }, "/wc/v2/products/{product_id}/variations/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, + "patch": { "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", "required": true, "schema": {} } @@ -53135,83 +68749,322 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", "required": true, "schema": {} } @@ -53220,83 +69073,256 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/products/{product_id}/variations/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, "parameters": [ { - "name": "product_id", - "in": "path", "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", "required": true, "schema": {} } @@ -53305,392 +69331,1051 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "description": { "type": "string", "description": "Variation description." }, - "sku": { "type": "string", "description": "Unique identifier." }, - "regular_price": { "type": "string", "description": "Variation regular price." }, - "sale_price": { "type": "string", "description": "Variation sale price." }, - "date_on_sale_from": { - "type": ["null", "string"], - "description": "Start date of sale price, in the site's timezone." - }, - "date_on_sale_from_gmt": { - "type": ["null", "string"], - "description": "Start date of sale price, as GMT." - }, - "date_on_sale_to": { - "type": ["null", "string"], - "description": "End date of sale price, in the site's timezone." - }, - "date_on_sale_to_gmt": { - "type": ["null", "string"], - "description": "End date of sale price, as GMT." - }, - "visible": { - "type": "boolean", - "description": "Define if the variation is visible on the product's page." - }, - "virtual": { "type": "boolean", "description": "If the variation is virtual." }, - "downloadable": { "type": "boolean", "description": "If the variation is downloadable." }, - "downloads": { "type": "array", "description": "List of downloadable files." }, - "download_limit": { - "type": "integer", - "description": "Number of times downloadable files can be downloaded after purchase." - }, - "download_expiry": { - "type": "integer", - "description": "Number of days until access to downloadable files expires." - }, - "tax_status": { "type": "string", "description": "Tax status." }, - "tax_class": { "type": "string", "description": "Tax class." }, - "manage_stock": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Stock management at variation level." - }, - "stock_quantity": { "type": "integer", "description": "Stock quantity." }, - "in_stock": { - "type": "boolean", - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end." + "attributes": { + "description": "List of attributes.", + "type": "array" }, "backorders": { - "type": "string", - "description": "If managing stock, this controls if back-orders are allowed." + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" }, - "weight": { "type": "string", "description": "Variation weight (kg)." }, - "dimensions": { "type": "object", "description": "Variation dimensions." }, - "shipping_class": { "type": "string", "description": "Shipping class slug." }, - "image": { "type": "object", "description": "Variation image data." }, - "attributes": { "type": "array", "description": "List of attributes." }, - "menu_order": { "type": "integer", "description": "Menu order, used to custom sort products." }, - "meta_data": { "type": "array", "description": "Meta data." } - } + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "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": [ + "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" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/reports/sales": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sales_report" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { - "name": "period", - "in": "query", "description": "Report period.", + "in": "query", + "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { - "name": "date_min", - "in": "query", "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" + } }, { - "name": "date_max", - "in": "query", "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" + } + } + }, + "description": "OK" + } + } } }, "/wc/v2/reports/top_sellers": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top_sellers_report" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } }, { - "name": "period", - "in": "query", "description": "Report period.", + "in": "query", + "name": "period", "required": false, - "schema": { "enum": ["week", "month", "last_month", "year"] } + "schema": { + "enum": [ + "last_month", + "month", + "week", + "year" + ] + } }, { - "name": "date_min", - "in": "query", "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" + } }, { - "name": "date_max", - "in": "query", "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" + } } - ] - } - }, - "/wc/v2/reports": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] + } } }, "/wc/v2/settings": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting_group" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, + "description": "OK" } } } }, "/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": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] + } } }, "/wc/v2/settings/{group_id}/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} } - }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } }, - "parameters": [{ "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" } } - } + }, + "description": "OK" } } } }, "/wc/v2/settings/{group_id}/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ - { "name": "group", "in": "query", "description": "Settings group ID.", "required": false, "schema": {} }, { - "name": "id", - "in": "path", + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ { - "name": "id", + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "group_id", "required": true, "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "group": { "type": "string", "description": "Settings group ID." }, - "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." - } - } - } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setting" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, - { "name": "group_id", "in": "path", "description": "", "required": true, "schema": {} } + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "group": { "type": "string", "description": "Settings group ID." }, + "group": { + "description": "Settings group ID.", + "type": "string" + }, "value": { - "type": ["null", "object", "string", "number", "boolean", "integer", "array"], - "description": "Setting value." + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } - } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } } }, @@ -53698,403 +70383,487 @@ "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" } } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "required": true, "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } }, - "required": ["name"] + "required": [ + "name" + ], + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, + "delete": { "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } }, - "put": { + "get": { + "parameters": [ + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" } } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "Shipping zone name." }, - "order": { "type": "integer", "description": "Shipping zone order." } - } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone" } } } - } - }, + "post": { "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{id}/locations": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } - } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_location" } } - } - } - }, "parameters": [ - { "name": "id", "in": "path", "description": "Unique ID for the resource.", "required": true, "schema": {} } + { + "description": "Unique ID for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "code": { "type": "string", "description": "Shipping zone location code." }, - "type": { "type": "string", "description": "Shipping zone location type." } - } + "code": { + "description": "Shipping zone location code.", + "type": "string" + }, + "type": { + "description": "Shipping zone location type.", + "type": "string" + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{zone_id}/methods": { "get": { + "parameters": [ + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} } - ] + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "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": { - "type": "object", "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." }, - "method_id": { "required": true, "description": "Shipping method ID." } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } } } }, "/wc/v2/shipping/zones/{zone_id}/methods/{instance_id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, - "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, - { - "name": "instance_id", - "in": "path", - "description": "Unique ID for the instance.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "order": { "type": "integer", "description": "Shipping method sort order." }, - "enabled": { "type": "boolean", "description": "Shipping method enabled status." }, - "settings": { "type": "object", "description": "Shipping method settings." } - } - } - } - } - } - }, "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_zone_method" } } } - } - }, "parameters": [ - { "name": "zone_id", "in": "path", "description": "Unique ID for the zone.", "required": true, "schema": {} }, { - "name": "instance_id", + "description": "Unique ID for the zone.", "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, + { "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", "required": true, "schema": {} } @@ -54103,715 +70872,73 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass bin and force deletion." } - } - } - } - } - } - } - }, - "/wc/v2/taxes/classes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "name": { "type": "string", "required": true, "description": "Tax class name." } }, - "required": ["name"] - } - } - } - } - } - }, - "/wc/v2/taxes/classes/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax_class" } } } - } - }, - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "Unique slug for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", "properties": { "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" } - } - } - } - } - } - } - }, - "/wc/v2/taxes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["id", "order", "priority"] } - }, - { - "name": "class", - "in": "query", - "description": "Sort by tax class.", - "required": false, - "schema": { "enum": ["standard", "reduced-rate", "zero-rate"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v2/taxes/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tax" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." - } - } - } - } - } - } - } - }, - "/wc/v2/taxes/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "country": { "type": "string", "description": "Country ISO 3166 code." }, - "state": { "type": "string", "description": "State code." }, - "postcode": { "type": "string", "description": "Postcode / ZIP." }, - "city": { "type": "string", "description": "City name." }, - "rate": { "type": "string", "description": "Tax rate." }, - "name": { "type": "string", "description": "Tax rate name." }, - "priority": { "type": "integer", "description": "Tax priority." }, - "compound": { "type": "boolean", "description": "Whether or not this is a compound rate." }, - "shipping": { - "type": "boolean", - "description": "Whether or not this tax rate also gets applied to shipping." - }, - "order": { "type": "integer", "description": "Indicates the order that will appear in queries." }, - "class": { "type": "string", "description": "Tax class." } - } - } - } - } - } - } - }, - "/wc/v2/webhooks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific ids.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "title"] } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to webhooks assigned a specific status.", - "required": false, - "schema": { "enum": ["all", "active", "paused", "disabled"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "required": true, "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - }, - "delivery_url": { "type": "string", "required": true, "description": "Webhook delivery URL." } }, - "required": ["topic", "delivery_url"] + "type": "object" } } } - } - } - }, - "/wc/v2/webhooks/{id}": { - "get": { + }, "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" } - }, + } + }, + "get": { "parameters": [ { - "name": "id", + "description": "Unique ID for the zone.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "zone_id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", + "description": "Unique ID for the instance.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "instance_id", "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } - } - } - } - } - } - }, - "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" } } - } + }, + "description": "OK" } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, "parameters": [ { - "name": "id", + "description": "Unique ID for the zone.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "zone_id", + "required": true, + "schema": {} + }, + { + "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", "required": true, "schema": {} } @@ -54820,33 +70947,51 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } } }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } - } - }, + "post": { "parameters": [ { - "name": "id", + "description": "Unique ID for the zone.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "zone_id", + "required": true, + "schema": {} + }, + { + "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", "required": true, "schema": {} } @@ -54855,415 +71000,246 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as resource does not support binning." + "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" } } } - } - } - }, - "/wc/v2/webhooks/batch": { - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" } } - } + }, + "description": "OK" } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } + "parameters": [ + { + "description": "Unique ID for the zone.", + "in": "path", + "name": "zone_id", + "required": true, + "schema": {} + }, + { + "description": "Unique ID for the instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} } - }, + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." + "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" } } } - } - }, - "patch": { + }, "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "A friendly name for the webhook." }, - "status": { "type": "string", "description": "Webhook status." }, - "topic": { "type": "string", "description": "Webhook topic." }, - "secret": { - "type": "string", - "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." - } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" } } - } - } - } - } - }, - "/wc/v2/webhooks/{webhook_id}/deliveries": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2/webhooks/{webhook_id}/deliveries/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_delivery" } } } - } - }, - "parameters": [ - { - "name": "webhook_id", - "in": "path", - "description": "Unique identifier for the webhook.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2/system_status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - } - ] - } - }, - "/wc/v2/system_status/tools": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] - } - }, - "/wc/v2/system_status/tools/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the resource.", - "required": true, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/system_status_tool" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "A unique identifier for the tool.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Tool name." }, - "action": { "type": "string", "description": "What running the tool will do." }, - "description": { "type": "string", "description": "Tool description." }, - "success": { "type": "boolean", "description": "Did the tool run successfully?" }, - "message": { "type": "string", "description": "Tool return message." } - } - } - } + }, + "description": "OK" } } } }, "/wc/v2/shipping_methods": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, "parameters": [ { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" + } + } } }, "/wc/v2/shipping_methods/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipping_method" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} }, { - "name": "context", - "in": "query", "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", "required": false, - "schema": { "enum": ["view"] } + "schema": { + "enum": [ + "view" + ] + } } - ] - } - }, - "/wc/v2/payment_gateways": { - "get": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } - } - ] + } } }, - "/wc/v2/payment_gateways/{id}": { + "/wc/v2/system_status": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/system_status/tools": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/system_status/tools/{id}": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", "required": true, "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "edit"] } } - ] + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, + "patch": { "parameters": [ { - "name": "id", + "description": "A unique identifier for the tool.", "in": "path", - "description": "Unique identifier for the resource.", + "name": "id", "required": true, "schema": {} } @@ -55272,31 +71248,14157 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } + "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" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes": { + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "order", + "priority" + ] + } + }, + { + "description": "Sort by tax class.", + "in": "query", + "name": "class", + "required": false, + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/classes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/classes/{slug}": { + "delete": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/taxes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "type": "boolean" + }, + "state": { + "description": "State code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "title" + ] + } + }, + { + "description": "Limit result set to webhooks assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "delivery_url", + "topic" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/{webhook_id}/deliveries": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v2/webhooks/{webhook_id}/deliveries/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the webhook.", + "in": "path", + "name": "webhook_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook_delivery" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/coupons": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "modified", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to resources with a specific code.", + "in": "query", + "name": "code", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "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" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "required": [ + "code" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/coupons/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/coupons/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "type": "string" + }, + "code": { + "description": "Coupon code.", + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "type": "boolean" + }, + "individual_use": { + "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": { + "description": "Max number of items in the basket the coupon can be applied to.", + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "type": "string" + }, + "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" + }, + "product_categories": { + "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" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_coupon" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "include", + "name", + "registered_date" + ] + } + }, + { + "description": "Limit result set to resources with a specific email.", + "in": "query", + "name": "email", + "required": false, + "schema": { + "format": "email" + } + }, + { + "description": "Limit result set to resources with a specific role.", + "in": "query", + "name": "role", + "required": false, + "schema": { + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "email", + "password" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers/batch": { + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers/{customer_id}/downloads": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "customer_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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer_download" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/customers/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "ID to reassign posts to.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/customer" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_index" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/continents": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/continents/{location}": { + "get": { + "parameters": [ + { + "description": "2 character continent code.", + "in": "query", + "name": "continent", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "location", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_continents" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/countries": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/countries/{location}": { + "get": { + "parameters": [ + { + "description": "ISO3166 alpha-2 country code.", + "in": "path", + "name": "location", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_countries" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/currencies": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/currencies/current": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/data/currencies/{currency}": { + "get": { + "parameters": [ + { + "description": "ISO4217 currency code.", + "in": "query", + "name": "location", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "currency", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/data_currencies" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/layout-templates": { + "get": { + "parameters": [ + { + "description": "Area to get templates for.", + "in": "query", + "name": "area", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/layout-templates/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/create-order": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "required": true + } + }, + "required": [ + "product_id" + ], + "type": "object" + } + } + } + }, + "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" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/subscriptions/connect": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/marketplace/subscriptions/disconnect": { + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_key": { + "required": true, + "type": "string" + } + }, + "required": [ + "product_key" + ], + "type": "object" + } + } + } + }, + "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" + } + } + } + }, + "/wc/v3/orders": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to orders which have specific statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set to orders assigned a specific customer.", + "in": "query", + "name": "customer", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to orders assigned a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{id}/receipt": { + "get": { + "parameters": [ + { + "description": "Unique identifier of the order.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier of the order.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "force_new": { + "description": "True to force the creation of a new receipt even if one already exists and has not expired yet.", + "required": false, + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "view" + ] + } + }, + { + "description": "Limit result to customers or internal notes.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "any", + "customer", + "internal" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "added_by_user": { + "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.", + "type": "boolean" + }, + "customer_note": { + "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" + } + }, + "required": [ + "note" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{order_id}/notes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/order_note" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{order_id}/refunds": { + "get": { + "parameters": [ + { + "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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/orders/{order_id}/refunds/{id}": { + "delete": { + "parameters": [ + { + "description": "The order ID.", + "in": "path", + "name": "order_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/payment_gateways": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/payment_gateways/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_gateway" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "popularity", + "price", + "rating", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit results to those with a SKU that partially matches a string.", + "in": "query", + "name": "search_sku", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{attribute_id}/terms": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{attribute_id}/terms/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{attribute_id}/terms/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the attribute of the terms.", + "in": "path", + "name": "attribute_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute_term" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/attributes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_attribute" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/categories": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/categories/batch": { + "patch": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/custom-fields/names": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": {} + }, + { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Order sort items ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wc/v3/products/reviews": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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 reviews published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "description": "Ensure result set excludes reviews assigned to specific user IDs.", + "in": "query", + "name": "reviewer_exclude", + "required": false, + "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" + } + }, + { + "description": "Limit result set to reviews assigned to specific product IDs.", + "in": "query", + "name": "product", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to reviews assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "description": "Unique identifier for the product.", + "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" + } + }, + "required": [ + "product_id", + "review", + "reviewer", + "reviewer_email" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/reviews/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/reviews/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "product_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_review" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes/slug-suggestion": { + "get": { + "parameters": [ + { + "description": "Shipping class name.", + "in": "query", + "name": "name", + "required": false, + "schema": {} + }, + { + "description": "An alphanumeric identifier for the resource unique to its type.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "HTML description of the resource.", + "in": "query", + "name": "description", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/shipping_classes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_shipping_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/suggested-products": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "menu_order", + "modified", + "popularity", + "popularity", + "rating", + "rating", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to those of particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "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": [ + "external", + "grouped", + "simple", + "variable" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to featured products.", + "in": "query", + "name": "featured", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific tag ID.", + "in": "query", + "name": "tag", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific shipping class ID.", + "in": "query", + "name": "shipping_class", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "in": "query", + "name": "attribute", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "in": "query", + "name": "attribute_term", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products in stock or out of stock.", + "in": "query", + "name": "in_stock", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to specific product categorie ids.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific product tag ids.", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific amount of suggested products.", + "in": "query", + "name": "limit", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/tags": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by resource attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide resources not assigned to any products.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources assigned to a specific product.", + "in": "query", + "name": "product", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to resources with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/tags/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier 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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{id}/duplicate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attributes": { + "description": "List of attributes.", + "type": "array" + }, + "backorders": { + "description": "If managing stock, this controls if back-orders are allowed.", + "type": "string" + }, + "button_text": { + "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_created": { + "description": "The date the product was created, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the product was created, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "description": "Start date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "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" + }, + "download_limit": { + "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" + }, + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the product.", + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_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": [ + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to products with a specific slug.", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "any", + "draft", + "future", + "pending", + "private", + "publish", + "trash" + ] + } + }, + { + "description": "Limit result set to products with specific SKU(s). Use commas to separate.", + "in": "query", + "name": "sku", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products on sale.", + "in": "query", + "name": "on_sale", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a minimum price.", + "in": "query", + "name": "min_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products based on a maximum price.", + "in": "query", + "name": "max_price", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Limit result set to products with specified stock status.", + "in": "query", + "name": "stock_status", + "required": false, + "schema": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ] + } + }, + { + "description": "Limit result set to products with or without price.", + "in": "query", + "name": "has_price", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to products with specified attributes.", + "in": "query", + "name": "attributes", + "required": false, + "schema": { + "items": { + "properties": { + "attribute": { + "description": "Attribute slug.", + "type": "string" + }, + "term": { + "description": "Attribute term.", + "type": "string" + }, + "terms": { + "description": "Attribute terms.", + "type": "array" + } + }, + "type": "object" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations/batch": { + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations/generate": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "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" + }, + "download_expiry": { + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/products/{product_id}/variations/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the variable product.", + "in": "path", + "name": "product_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the variation.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + ] + }, + "date_on_sale_from_gmt": { + "description": "Start date of sale price, as GMT.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "date_on_sale_to_gmt": { + "description": "End date of sale price, in the site's timezone.", + "type": [ + "null", + "string" + ] + }, + "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" + }, + "download_limit": { + "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" + }, + "low_stock_amount": { + "description": "Low Stock amount for the variation.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_variation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/refunds": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Limit response to resources modified after a given ISO8601 compliant date.", + "in": "query", + "name": "modified_after", + "required": false, + "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" + } + }, + { + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "in": "query", + "name": "dates_are_gmt", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Number of decimal points to use in each resource.", + "in": "query", + "name": "dp", + "required": false, + "schema": {} + }, + { + "description": "Only show meta which is meant to be displayed for an order.", + "in": "query", + "name": "order_item_display_meta", + "required": false, + "schema": {} + }, + { + "description": "Limit meta_data to specific keys.", + "in": "query", + "name": "include_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "description": "Ensure meta_data excludes specific keys.", + "in": "query", + "name": "exclude_meta", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shop_order_refund" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/coupons/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_coupon_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/customers/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_customer_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/orders/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_order_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/products/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_product_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/reviews/totals": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/report_review_total" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/sales": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sales_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/reports/top_sellers": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + }, + { + "description": "Report period.", + "in": "query", + "name": "period", + "required": false, + "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" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/top_sellers_report" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting_group" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings/batch": { + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } } }, "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" } - }, + } + } + }, + "/wc/v3/settings/{group_id}": { + "get": { "parameters": [ { - "name": "id", + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "", "in": "path", - "description": "Unique identifier for the resource.", + "name": "group_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings/{group_id}/batch": { + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "group_id", "required": true, "schema": {} } @@ -55305,31 +85407,194 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } + "group": { + "description": "Settings group ID.", + "type": "string" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/settings/{group_id}/{id}": { + "get": { + "parameters": [ + { + "description": "Settings group ID.", + "in": "query", + "name": "group", + "required": false, + "schema": {} + }, + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } }, "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_gateway" } } } - } - }, "parameters": [ { - "name": "id", - "in": "path", "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", "required": true, "schema": {} } @@ -55338,11069 +85603,2966 @@ "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "title": { "type": "string", "description": "Payment gateway title on checkout." }, - "description": { "type": "string", "description": "Payment gateway description on checkout." }, - "order": { "type": "integer", "description": "Payment gateway sort order." }, - "enabled": { "type": "boolean", "description": "Payment gateway enabled status." }, - "settings": { "type": "object", "description": "Payment gateway settings." } - } + "group": { + "description": "Settings group ID.", + "type": "string" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } } - } - }, - "/wc-telemetry": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wc-telemetry/tracker": { + }, "post": { - "responses": { "200": { "description": "OK" } }, + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "group_id", + "required": true, + "schema": {} + } + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "platform": { "type": "string", "required": true, "description": "Platform to track." }, - "version": { "type": "string", "required": true, "description": "Platform version to track." }, - "installation_date": { - "type": "string", - "required": false, - "description": "Installation date of the WooCommerce mobile app." + "group": { + "description": "Settings group ID.", + "type": "string" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] } }, - "required": ["platform", "version"] + "type": "object" } } } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "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" + }, + "value": { + "description": "Setting value.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setting" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones/{id}": { + "delete": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Shipping zone name.", + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones/{id}/locations": { + "get": { + "parameters": [ + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_location" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping/zones/{zone_id}/methods": { + "get": { + "parameters": [ + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "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" + } + }, + "required": [ + "method_id" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Whether to bypass bin and force deletion.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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 instance.", + "in": "path", + "name": "instance_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_zone_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping_methods": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/shipping_methods/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier 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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/shipping_method" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/system_status": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/system_status/tools": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/system_status/tools/{id}": { + "get": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "A unique identifier for the tool.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/system_status_tool" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes": { + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "id", + "order", + "priority" + ] + } + }, + { + "description": "Sort by tax class.", + "in": "query", + "name": "class", + "required": false, + "schema": { + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/classes": { + "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" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/classes/{slug}": { + "delete": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique slug for the resource.", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax_class" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/taxes/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/webhooks": { + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific ids.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "title" + ] + } + }, + { + "description": "Limit result set to webhooks assigned a specific status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "all", + "disabled", + "paused" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "delivery_url", + "topic" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/webhooks/batch": { + "patch": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/batch" + } + } + }, + "description": "OK" + } + } + } + }, + "/wc/v3/webhooks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as resource does not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier 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": [ + "edit", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook" + } + } + }, + "description": "OK" + } } } }, "/wccom-site/v3": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } } }, "/wccom-site/v3/installer": { - "post": { - "responses": { "200": { "description": "OK" } }, + "patch": { "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product-id": { "type": "integer", "required": true }, - "run-until-step": { "type": "string", "required": true }, - "idempotency-key": { "type": "string", "required": true } + "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" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "idempotency-key", + "product-id", + "run-until-step" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } } }, "put": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product-id": { "type": "integer", "required": true }, - "run-until-step": { "type": "string", "required": true }, - "idempotency-key": { "type": "string", "required": true } + "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" } } } - } - }, - "patch": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product-id": { "type": "integer", "required": true }, - "run-until-step": { "type": "string", "required": true }, - "idempotency-key": { "type": "string", "required": true } - }, - "required": ["product-id", "run-until-step", "idempotency-key"] - } - } + }, + "responses": { + "200": { + "description": "OK" } } } }, "/wccom-site/v3/installer/reset": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product-id": { "type": "integer", "required": true }, - "idempotency-key": { "type": "string", "required": true } - }, - "required": ["product-id", "idempotency-key"] - } - } - } - } - }, - "put": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "product-id": { "type": "integer", "required": true }, - "idempotency-key": { "type": "string", "required": true } - }, - "required": ["product-id", "idempotency-key"] - } - } - } - } - }, "patch": { - "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "product-id": { "type": "integer", "required": true }, - "idempotency-key": { "type": "string", "required": true } + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } }, - "required": ["product-id", "idempotency-key"] - } - } - } - } - } - }, - "/wccom-site/v3/ssr": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wccom-site/v3/status": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/carbon-fields/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/carbon-fields/v1/posts/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/terms/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/users/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/comments/{id}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/carbon-fields/v1/options": { - "get": { "responses": { "200": { "description": "OK" } } }, - "post": { "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": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "type", - "in": "query", - "description": "The requested type: ID or URL.", - "required": true, - "schema": {} - }, - { - "name": "value", - "in": "query", - "description": "The ID / URL of the attachment", - "required": true, - "schema": {} - } - ] - } - }, - "/carbon-fields/v1/block-renderer": { - "post": { - "responses": { "200": { "description": "OK" } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "required": true, "description": "The name of the block." }, - "content": { "type": "string", "required": true, "description": "The content of the block." }, - "post_id": { "type": "integer", "description": "ID of the post context." } - }, - "required": ["name", "content"] - } - } - } - } - } - }, - "/wp/v2": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp/v2/posts": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "required": [ + "idempotency-key", + "product-id" ], - "type": "string" + "type": "object" } } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "categories", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "categories_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "tags", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "tags_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "sticky", - "in": "query", - "description": "Limit result set to items that are sticky.", - "required": false, - "schema": {} } - ] + }, + "responses": { + "200": { + "description": "OK" + } + } }, "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." + "idempotency-key": { + "required": true, + "type": "string" }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." + "product-id": { + "required": true, + "type": "integer" } - } - } - } - } - } - } - }, - "/wp/v2/posts/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/posts/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/posts/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/posts/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "format": { "type": "string", "description": "The format for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "sticky": { - "type": "boolean", - "description": "Whether or not the post should be treated as sticky." - }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "categories": { - "type": "array", - "description": "The terms assigned to the object in the category taxonomy." - }, - "tags": { - "type": "array", - "description": "The terms assigned to the object in the post_tag taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/posts/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/pages": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "menu_order", - "in": "query", - "description": "Limit result set to posts with a specific menu_order value.", - "required": false, - "schema": {} - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "menu_order" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to items with particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + }, + "required": [ + "idempotency-key", + "product-id" ], - "type": "string" + "type": "object" } } } - ] - }, - "post": { + }, "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/pages/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } + "description": "OK" } } }, "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { - "type": "object", "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." + "idempotency-key": { + "required": true, + "type": "string" }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/pages/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/pages/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/pages/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "menu_order": { - "type": "integer", - "description": "The order of the post in relation to other posts." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/pages/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/page-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/media": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes posts assigned to specific authors.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] - } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to items with particular parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Limit result set to all items except those of a particular parent ID.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { "items": { "enum": ["inherit", "private", "trash"], "type": "string" } } - }, - { - "name": "media_type", - "in": "query", - "description": "Limit result set to attachments of a particular media type.", - "required": false, - "schema": { "enum": ["image", "video", "application"] } - }, - { - "name": "mime_type", - "in": "query", - "description": "Limit result set to attachments of a particular MIME type.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - } - }, - "/wp/v2/media/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "title": { "type": "object", "description": "The title for the post." }, - "author": { "type": "integer", "description": "The ID for the author of the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "comment_status": { - "type": "string", - "description": "Whether or not comments are open on the post." - }, - "ping_status": { "type": "string", "description": "Whether or not the post can be pinged." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "alt_text": { - "type": "string", - "description": "Alternative text to display when attachment is not displayed." - }, - "caption": { "type": "object", "description": "The attachment caption." }, - "description": { "type": "object", "description": "The attachment description." }, - "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/media/{id}/post-process": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the attachment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "action": { "type": "string", "required": true } }, - "required": ["action"] - } - } - } - } - } - }, - "/wp/v2/media/{id}/edit": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "src": { "type": "string", "required": true, "description": "URL to the edited image file." }, - "modifiers": { "type": "array", "description": "Array of image edits." }, - "rotation": { - "type": "integer", - "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead." - }, - "x": { - "type": "number", - "description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead." - }, - "y": { - "type": "number", - "description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead." - }, - "width": { - "type": "number", - "description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead." - }, - "height": { - "type": "number", - "description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead." + "product-id": { + "required": true, + "type": "integer" } }, - "required": ["src"] - } - } - } - } - } - }, - "/wp/v2/menu-items": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "menu_order" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" + "required": [ + "idempotency-key", + "product-id" ], - "type": "string" + "type": "object" } } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "menus", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "menus_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "menu_order", - "in": "query", - "description": "Limit result set to posts with a specific menu_order value.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } } }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } + "responses": { + "200": { + "description": "OK" } } } }, - "/wp/v2/menu-items/{id}": { + "/wccom-site/v3/ssr": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } + "description": "OK" } - }, + } + } + }, + "/wccom-site/v3/status": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-block-editor/v1": { + "get": { "parameters": [ { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, + "description": "", + "in": "query", + "name": "namespace", + "required": false, "schema": {} }, { + "description": "", + "in": "query", "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } + "description": "OK" } } } }, - "/wp/v2/menu-items/{id}/autosaves": { + "/wp-block-editor/v1/export": { + "get": { + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp-block-editor/v1/navigation-fallback": { "get": { "responses": { "200": { - "description": "OK", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } - } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the object." }, - "title": { "type": ["string", "object"], "description": "The title for the object." }, - "type": { - "type": "string", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "attr_title": { - "type": "string", - "description": "Text for the title attribute of the link element for this menu item." - }, - "classes": { "type": "array", "description": "Class names for the link element of this menu item." }, - "description": { "type": "string", "description": "The description of this menu item." }, - "menu_order": { - "type": "integer", - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." - }, - "object": { - "type": "string", - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." - }, - "object_id": { - "type": "integer", - "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." - }, - "target": { - "type": "string", - "description": "The target attribute of the link element for this menu item." - }, - "url": { "type": "string", "description": "The URL to which this menu item points." }, - "xfn": { - "type": "array", - "description": "The XFN relationship expressed in the link of this menu item." - }, - "menus": { - "type": "integer", - "description": "The terms assigned to the object in the nav_menu taxonomy." - }, - "meta": { "type": "object", "description": "Meta fields." } + "application/json": { + "schema": { + "$ref": "#/components/schemas/navigation-fallback" } } - } + }, + "description": "OK" } } } }, - "/wp/v2/menu-items/{parent}/autosaves/{id}": { + "/wp-block-editor/v1/url-details": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu_item-revision" } } - } - } - }, "parameters": [ { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", + "description": "The URL to process.", + "in": "query", + "name": "url", "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/blocks": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] + "format": "uri" } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - } - } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "wp_pattern_category", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "wp_pattern_category_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/blocks/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } - } - } - }, - "delete": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } + "description": "OK" } } } }, - "/wp/v2/blocks/{parent}/revisions": { + "/wp-openapi/v1": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, "parameters": [ { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", + "description": "", "in": "query", - "description": "Offset the result set by a specific number of items.", + "name": "namespace", "required": false, "schema": {} }, { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", + "description": "", "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/blocks/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, "schema": {} } ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/blocks/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "wp_pattern_category": { - "type": "array", - "description": "The terms assigned to the object in the wp_pattern_category taxonomy." - } - } - } - } + "description": "OK" } } } }, - "/wp/v2/blocks/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_block-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/templates/{parent}/revisions": { + "/wp-openapi/v1/schema": { "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, { - "name": "orderby", + "description": "", "in": "query", - "description": "Sort collection by object attribute.", + "name": "namespace", "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/templates/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } } - ] - }, - "delete": { + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } + "description": "OK" } } } }, - "/wp/v2/templates/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - } - }, - "/wp/v2/templates/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/templates": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "wp_id", - "in": "query", - "description": "Limit to the specified post ID.", - "required": false, - "schema": {} - }, - { - "name": "area", - "in": "query", - "description": "Limit to the specified template part area.", - "required": false, - "schema": {} - }, - { - "name": "post_type", - "in": "query", - "description": "Post type for which to get the templates.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { - "type": "string", - "required": true, - "description": "Unique slug identifying the template." - }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - }, - "required": ["slug"] - } - } - } - } - } - }, - "/wp/v2/templates/lookup": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "slug", - "in": "query", - "description": "The slug of the template to get the fallback for", - "required": true, - "schema": {} - }, - { - "name": "is_custom", - "in": "query", - "description": "Indicates if a template is custom or part of the template hierarchy", - "required": false, - "schema": {} - }, - { - "name": "template_prefix", - "in": "query", - "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/templates/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/template-parts/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/template-parts/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/template-parts/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - } - }, - "/wp/v2/template-parts/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "parent", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/template-parts": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "wp_id", - "in": "query", - "description": "Limit to the specified post ID.", - "required": false, - "schema": {} - }, - { - "name": "area", - "in": "query", - "description": "Limit to the specified template part area.", - "required": false, - "schema": {} - }, - { - "name": "post_type", - "in": "query", - "description": "Post type for which to get the templates.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { - "type": "string", - "required": true, - "description": "Unique slug identifying the template." - }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - }, - "required": ["slug"] - } - } - } - } - } - }, - "/wp/v2/template-parts/lookup": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "slug", - "in": "query", - "description": "The slug of the template to get the fallback for", - "required": true, - "schema": {} - }, - { - "name": "is_custom", - "in": "query", - "description": "Indicates if a template is custom or part of the template hierarchy", - "required": false, - "schema": {} - }, - { - "name": "template_prefix", - "in": "query", - "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/template-parts/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "description": "Unique slug identifying the template." }, - "theme": { "type": "string", "description": "Theme identifier for the template." }, - "type": { "type": "string", "description": "Type of template." }, - "content": { "type": ["object", "string"], "description": "Content of template." }, - "title": { "type": ["object", "string"], "description": "Title of template." }, - "description": { "type": "string", "description": "Description of template." }, - "status": { "type": "string", "description": "Status of template." }, - "author": { "type": "integer", "description": "The ID for the author of the template." }, - "area": { - "type": "string", - "description": "Where the template part is intended for use (header, footer, etc)" - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_template_part" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/global-styles/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/global-styles/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the global styles revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the global styles revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/global-styles/themes/{stylesheet}/variations": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "stylesheet", "in": "path", "description": "The theme identifier", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/global-styles/themes/{stylesheet}": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "stylesheet", "in": "path", "description": "The theme identifier", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/global-styles/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The ID of a template", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "styles": { "type": ["object"], "description": "Global styles." }, - "settings": { "type": ["object"], "description": "Global settings." }, - "title": { "type": ["object", "string"], "description": "Title of the global styles variation." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "styles": { "type": ["object"], "description": "Global styles." }, - "settings": { "type": ["object"], "description": "Global settings." }, - "title": { "type": ["object", "string"], "description": "Title of the global styles variation." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_global_styles" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "styles": { "type": ["object"], "description": "Global styles." }, - "settings": { "type": ["object"], "description": "Global settings." }, - "title": { "type": ["object", "string"], "description": "Title of the global styles variation." } - } - } - } - } - } - } - }, - "/wp/v2/navigation": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{parent}/revisions": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by object attribute.", - "required": false, - "schema": { "enum": ["date", "id", "include", "relevance", "slug", "include_slugs", "title"] } - } - ] - } - }, - "/wp/v2/navigation/{parent}/revisions/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the revision.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the revision.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as revisions do not support binning." - } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "template": { "type": "string", "description": "The theme file to use to display the post." } - } - } - } - } - } - } - }, - "/wp/v2/navigation/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/wp_navigation-revision" } } - } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/font-families": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { "enum": ["id", "include"] } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - } - }, - "/wp/v2/font-families/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_family_settings": { - "type": "string", - "required": true, - "description": "font-family declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_family_settings"] - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_family" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/font-families/{font_family_id}/font-faces": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { "enum": ["id", "include"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "theme_json_version": { - "type": "integer", - "description": "Version of the theme.json schema used for the typography settings." - }, - "font_face_settings": { - "type": "string", - "required": true, - "description": "font-face declaration in theme.json format, encoded as a string." - } - }, - "required": ["font_face_settings"] - } - } - } - } - } - }, - "/wp/v2/font-families/{font_family_id}/font-faces/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the font face.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_font_face" } } } - } - }, - "parameters": [ - { - "name": "font_family_id", - "in": "path", - "description": "The ID for the parent font family of the font face.", - "required": true, - "schema": {} - }, - { - "name": "id", - "in": "path", - "description": "Unique identifier for the font face.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/product": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_after", - "in": "query", - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "modified_before", - "in": "query", - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "popularity", - "rating", - "popularity", - "rating" - ] - } - }, - { - "name": "search_columns", - "in": "query", - "description": "Array of column names to be searched.", - "required": false, - "schema": { "items": { "enum": ["post_title", "post_content", "post_excerpt"], "type": "string" } } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to posts with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to posts assigned one or more statuses.", - "required": false, - "schema": { - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - } - } - }, - { - "name": "tax_relation", - "in": "query", - "description": "Limit result set based on relationship between multiple taxonomies.", - "required": false, - "schema": { "enum": ["AND", "OR"] } - }, - { - "name": "product_cat", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "product_cat_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "product_tag", - "in": "query", - "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": ["AND", "OR"], - "default": "OR" - } - }, - "additionalProperties": false - } - ] - } - }, - { - "name": "product_tag_exclude", - "in": "query", - "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", - "required": false, - "schema": { - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { "type": "integer" } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { "type": "integer" }, - "default": [] - } - }, - "additionalProperties": false - } - ] - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/product/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "excerpt_length", - "in": "query", - "description": "Override the default excerpt length.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the post.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." } - } - } - } - } - } - } - }, - "/wp/v2/product/{id}/autosaves": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "query", - "description": "The ID for the parent of the autosave.", - "required": false, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, - "date": { - "type": ["string", "null"], - "description": "The date the post was published, in the site's time zone." - }, - "date_gmt": { "type": ["string", "null"], "description": "The date the post was published, as GMT." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the post unique to its type." - }, - "status": { "type": "string", "description": "A named status for the object." }, - "password": { - "type": "string", - "description": "A password to protect access to the content and excerpt." - }, - "title": { "type": "object", "description": "The title for the post." }, - "content": { "type": "object", "description": "The content for the post." }, - "excerpt": { "type": "object", "description": "The excerpt for the post." }, - "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, - "meta": { "type": "object", "description": "Meta fields." }, - "template": { "type": "string", "description": "The theme file to use to display the post." }, - "product_cat": { - "type": "array", - "description": "The terms assigned to the object in the product_cat taxonomy." - }, - "product_tag": { - "type": "array", - "description": "The terms assigned to the object in the product_tag taxonomy." - } - } - } - } - } - } - } - }, - "/wp/v2/product/{parent}/autosaves/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product-revision" } } } - } - }, - "parameters": [ - { - "name": "parent", - "in": "path", - "description": "The ID for the parent of the autosave.", - "required": true, - "schema": {} - }, - { "name": "id", "in": "path", "description": "The ID for the autosave.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/types/{type}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/type" } } } - } - }, - "parameters": [ - { - "name": "type", - "in": "path", - "description": "An alphanumeric identifier for the post type.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/statuses": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/statuses/{status}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status" } } } - } - }, - "parameters": [ - { - "name": "status", - "in": "path", - "description": "An alphanumeric identifier for the status.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/taxonomies": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "type", - "in": "query", - "description": "Limit results to taxonomies associated with a specific post type.", - "required": false, - "schema": {} - } - ] - } - }, - "/wp/v2/taxonomies/{taxonomy}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxonomy" } } } - } - }, - "parameters": [ - { - "name": "taxonomy", - "in": "path", - "description": "An alphanumeric identifier for the taxonomy.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to terms assigned to a specific parent.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/categories/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/tags": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/tags/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/menus": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/menus/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." }, - "locations": { "type": "array", "description": "The locations assigned to the menu." }, - "auto_add": { - "type": "boolean", - "description": "Whether to automatically add top-level pages to this menu." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nav_menu" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/wp_pattern_category": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/wp_pattern_category/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp_pattern_category" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/product_cat": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to terms assigned to a specific parent.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/product_cat/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "parent": { "type": "integer", "description": "The parent term ID." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_cat" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/product_tag": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by term attribute.", - "required": false, - "schema": { - "enum": ["id", "include", "name", "slug", "include_slugs", "term_group", "description", "count"] - } - }, - { - "name": "hide_empty", - "in": "query", - "description": "Whether to hide terms not assigned to any posts.", - "required": false, - "schema": {} - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to terms assigned to a specific post.", - "required": false, - "schema": {} - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to terms with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "required": true, "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["name"] - } - } - } - } - } - }, - "/wp/v2/product_tag/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "description": { "type": "string", "description": "HTML description of the term." }, - "name": { "type": "string", "description": "HTML title for the term." }, - "slug": { - "type": "string", - "description": "An alphanumeric identifier for the term unique to its type." - }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_tag" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the term.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Required to be true, as terms do not support binning." } - } - } - } - } - } - } - }, - "/wp/v2/users": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by user attribute.", - "required": false, - "schema": { "enum": ["id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url"] } - }, - { - "name": "slug", - "in": "query", - "description": "Limit result set to users with one or more specific slugs.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "roles", - "in": "query", - "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "capabilities", - "in": "query", - "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", - "required": false, - "schema": { "items": { "type": "string" } } - }, - { - "name": "who", - "in": "query", - "description": "Limit result set to users who are considered authors.", - "required": false, - "schema": { "enum": ["authors"] } - }, - { - "name": "has_published_posts", - "in": "query", - "description": "Limit result set to users who have published posts.", - "required": false, - "schema": { - "items": { - "type": "string", - "enum": { - "post": "post", - "page": "page", - "attachment": "attachment", - "nav_menu_item": "nav_menu_item", - "wp_block": "wp_block", - "wp_template": "wp_template", - "wp_template_part": "wp_template_part", - "wp_global_styles": "wp_global_styles", - "wp_navigation": "wp_navigation", - "wp_font_family": "wp_font_family", - "wp_font_face": "wp_font_face", - "product": "product" - } - } - } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "required": true, "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "required": true, "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { - "type": "string", - "required": true, - "description": "Password for the user (never included)." - }, - "meta": { "type": "object", "description": "Meta fields." } - }, - "required": ["username", "email", "password"] - } - } - } - } - } - }, - "/wp/v2/users/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the user.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as users do not support binning." - }, - "reassign": { - "type": "integer", - "required": true, - "description": "Reassign the deleted user's posts and links to this user ID." - } - }, - "required": ["reassign"] - } - } - } - } - } - }, - "/wp/v2/users/me": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "username": { "type": "string", "description": "Login name for the user." }, - "name": { "type": "string", "description": "Display name for the user." }, - "first_name": { "type": "string", "description": "First name for the user." }, - "last_name": { "type": "string", "description": "Last name for the user." }, - "email": { "type": "string", "description": "The email address for the user." }, - "url": { "type": "string", "description": "URL of the user." }, - "description": { "type": "string", "description": "Description of the user." }, - "locale": { "type": "string", "description": "Locale for the user." }, - "nickname": { "type": "string", "description": "The nickname for the user." }, - "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, - "roles": { "type": "array", "description": "Roles assigned to the user." }, - "password": { "type": "string", "description": "Password for the user (never included)." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Required to be true, as users do not support binning." - }, - "reassign": { - "type": "integer", - "required": true, - "description": "Reassign the deleted user's posts and links to this user ID." - } - }, - "required": ["reassign"] - } - } - } - } - } - }, - "/wp/v2/users/{user_id}/application-passwords": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [{ "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "required": true, "description": "The name of the application password." } - }, - "required": ["name"] - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [{ "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }] - } - }, - "/wp/v2/users/{user_id}/application-passwords/introspect": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/users/{user_id}/application-passwords/{uuid}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "description": "The name of the application password." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "description": "The name of the application password." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "app_id": { - "type": "string", - "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." - }, - "name": { "type": "string", "description": "The name of the application password." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-password" } } } - } - }, - "parameters": [ - { "name": "user_id", "in": "path", "description": "", "required": true, "schema": {} }, - { "name": "uuid", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/comments": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "after", - "in": "query", - "description": "Limit response to comments published after a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "author", - "in": "query", - "description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_exclude", - "in": "query", - "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "author_email", - "in": "query", - "description": "Limit result set to that from a specific author email. Requires authorisation.", - "required": false, - "schema": { "format": "email" } - }, - { - "name": "before", - "in": "query", - "description": "Limit response to comments published before a given ISO8601 compliant date.", - "required": false, - "schema": { "format": "date-time" } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by comment attribute.", - "required": false, - "schema": { "enum": ["date", "date_gmt", "id", "include", "post", "parent", "type"] } - }, - { - "name": "parent", - "in": "query", - "description": "Limit result set to comments of specific parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "parent_exclude", - "in": "query", - "description": "Ensure result set excludes specific parent IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "post", - "in": "query", - "description": "Limit result set to comments assigned to specific post IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "status", - "in": "query", - "description": "Limit result set to comments assigned a specific status. Requires authorisation.", - "required": false, - "schema": {} - }, - { - "name": "type", - "in": "query", - "description": "Limit result set to comments assigned a specific type. Requires authorisation.", - "required": false, - "schema": {} - }, - { - "name": "password", - "in": "query", - "description": "The password for the post if it is password protected.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - } - }, - "/wp/v2/comments/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "password", - "in": "query", - "description": "The password for the parent post of the comment (if the post is password protected).", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, - "author_email": { "type": "string", "description": "Email address for the comment author." }, - "author_ip": { "type": "string", "description": "IP address for the comment author." }, - "author_name": { "type": "string", "description": "Display name for the comment author." }, - "author_url": { "type": "string", "description": "URL for the comment author." }, - "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, - "content": { "type": "object", "description": "The content for the comment." }, - "date": { - "type": "string", - "description": "The date the comment was published, in the site's time zone." - }, - "date_gmt": { "type": "string", "description": "The date the comment was published, as GMT." }, - "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, - "post": { "type": "integer", "description": "The ID of the associated post object." }, - "status": { "type": "string", "description": "State of the comment." }, - "meta": { "type": "object", "description": "Meta fields." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the comment.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { "type": "boolean", "description": "Whether to bypass Bin and force deletion." }, - "password": { - "type": "string", - "description": "The password for the parent post of the comment (if the post is password protected)." - } - } - } - } - } - } - } - }, - "/wp/v2/search": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search-result" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "type", - "in": "query", - "description": "Limit results to items of an object type.", - "required": false, - "schema": { "enum": ["post", "term", "post-format"] } - }, - { - "name": "subtype", - "in": "query", - "description": "Limit results to items of one or more object subtypes.", - "required": false, - "schema": { - "items": { - "enum": ["post", "page", "product", "category", "post_tag", "product_cat", "product_tag", "any"], - "type": "string" - } - } - }, - { - "name": "exclude", - "in": "query", - "description": "Ensure result set excludes specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - }, - { - "name": "include", - "in": "query", - "description": "Limit result set to specific IDs.", - "required": false, - "schema": { "items": { "type": "integer" } } - } - ] - } - }, - "/wp/v2/block-renderer/{name}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } } - } - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Unique registered name for the block.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["edit"] } - }, - { - "name": "attributes", - "in": "query", - "description": "Attributes for the block.", - "required": false, - "schema": {} - }, - { - "name": "post_id", - "in": "query", - "description": "ID of the post context.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rendered-block" } } } - } - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Unique registered name for the block.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "attributes": { "type": "object", "description": "Attributes for the block." }, - "post_id": { "type": "integer", "description": "ID of the post context." } - } - } - } - } - } - } - }, - "/wp/v2/block-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "namespace", "in": "query", "description": "Block namespace.", "required": false, "schema": {} } - ] - } - }, - "/wp/v2/block-types/{namespace}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "namespace", "in": "path", "description": "Block namespace.", "required": true, "schema": {} } - ] - } - }, - "/wp/v2/block-types/{namespace}/{name}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-type" } } } - } - }, - "parameters": [ - { "name": "name", "in": "path", "description": "Block name.", "required": true, "schema": {} }, - { "name": "namespace", "in": "path", "description": "Block namespace.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/settings": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - } - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Site title." }, - "description": { "type": "string", "description": "Site tagline." }, - "url": { "type": "string", "description": "Site URL." }, - "email": { - "type": "string", - "description": "This address is used for admin purposes, like new user notification." - }, - "timezone": { "type": "string", "description": "A city in the same timezone as you." }, - "date_format": { "type": "string", "description": "A date format for all date strings." }, - "time_format": { "type": "string", "description": "A time format for all time strings." }, - "start_of_week": { - "type": "integer", - "description": "A day number of the week that the week should start on." - }, - "language": { "type": "string", "description": "WordPress locale code." }, - "use_smilies": { - "type": "boolean", - "description": "Convert emoticons like :-) and :-P to graphics on display." - }, - "default_category": { "type": "integer", "description": "Default post category." }, - "default_post_format": { "type": "string", "description": "Default post format." }, - "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, - "show_on_front": { "type": "string", "description": "What to show on the front page" }, - "page_on_front": { - "type": "integer", - "description": "The ID of the page that should be displayed on the front page" - }, - "page_for_posts": { - "type": "integer", - "description": "The ID of the page that should display the latest posts" - }, - "default_ping_status": { - "type": "string", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." - }, - "default_comment_status": { - "type": "string", - "description": "Allow people to submit comments on new posts." - }, - "site_logo": { "type": "integer", "description": "Site logo." }, - "site_icon": { "type": "integer", "description": "Site icon." }, - "pickup_location_settings": { - "type": "object", - "description": "WooCommerce Local Pickup Method Settings" - }, - "pickup_locations": { "type": "array", "description": "WooCommerce Local Pickup Locations" } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Site title." }, - "description": { "type": "string", "description": "Site tagline." }, - "url": { "type": "string", "description": "Site URL." }, - "email": { - "type": "string", - "description": "This address is used for admin purposes, like new user notification." - }, - "timezone": { "type": "string", "description": "A city in the same timezone as you." }, - "date_format": { "type": "string", "description": "A date format for all date strings." }, - "time_format": { "type": "string", "description": "A time format for all time strings." }, - "start_of_week": { - "type": "integer", - "description": "A day number of the week that the week should start on." - }, - "language": { "type": "string", "description": "WordPress locale code." }, - "use_smilies": { - "type": "boolean", - "description": "Convert emoticons like :-) and :-P to graphics on display." - }, - "default_category": { "type": "integer", "description": "Default post category." }, - "default_post_format": { "type": "string", "description": "Default post format." }, - "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, - "show_on_front": { "type": "string", "description": "What to show on the front page" }, - "page_on_front": { - "type": "integer", - "description": "The ID of the page that should be displayed on the front page" - }, - "page_for_posts": { - "type": "integer", - "description": "The ID of the page that should display the latest posts" - }, - "default_ping_status": { - "type": "string", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." - }, - "default_comment_status": { - "type": "string", - "description": "Allow people to submit comments on new posts." - }, - "site_logo": { "type": "integer", "description": "Site logo." }, - "site_icon": { "type": "integer", "description": "Site icon." }, - "pickup_location_settings": { - "type": "object", - "description": "WooCommerce Local Pickup Method Settings" - }, - "pickup_locations": { "type": "array", "description": "WooCommerce Local Pickup Locations" } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/settings" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "title": { "type": "string", "description": "Site title." }, - "description": { "type": "string", "description": "Site tagline." }, - "url": { "type": "string", "description": "Site URL." }, - "email": { - "type": "string", - "description": "This address is used for admin purposes, like new user notification." - }, - "timezone": { "type": "string", "description": "A city in the same timezone as you." }, - "date_format": { "type": "string", "description": "A date format for all date strings." }, - "time_format": { "type": "string", "description": "A time format for all time strings." }, - "start_of_week": { - "type": "integer", - "description": "A day number of the week that the week should start on." - }, - "language": { "type": "string", "description": "WordPress locale code." }, - "use_smilies": { - "type": "boolean", - "description": "Convert emoticons like :-) and :-P to graphics on display." - }, - "default_category": { "type": "integer", "description": "Default post category." }, - "default_post_format": { "type": "string", "description": "Default post format." }, - "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, - "show_on_front": { "type": "string", "description": "What to show on the front page" }, - "page_on_front": { - "type": "integer", - "description": "The ID of the page that should be displayed on the front page" - }, - "page_for_posts": { - "type": "integer", - "description": "The ID of the page that should display the latest posts" - }, - "default_ping_status": { - "type": "string", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." - }, - "default_comment_status": { - "type": "string", - "description": "Allow people to submit comments on new posts." - }, - "site_logo": { "type": "integer", "description": "Site logo." }, - "site_icon": { "type": "integer", "description": "Site icon." }, - "pickup_location_settings": { - "type": "object", - "description": "WooCommerce Local Pickup Method Settings" - }, - "pickup_locations": { "type": "array", "description": "WooCommerce Local Pickup Locations" } - } - } - } - } - } - } - }, - "/wp/v2/themes": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } } - } - }, - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Limit result set to themes assigned one or more statuses.", - "required": false, - "schema": { "items": { "enum": ["active", "inactive"], "type": "string" } } - } - ] - } - }, - "/wp/v2/themes/{stylesheet}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/theme" } } } - } - }, - "parameters": [ - { - "name": "stylesheet", - "in": "path", - "description": "The theme's style sheet. This uniquely identifies the theme.", - "required": true, - "schema": {} - } - ] - } - }, - "/wp/v2/plugins": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": {} - }, - { - "name": "status", - "in": "query", - "description": "Limits results to plugins with the given status.", - "required": false, - "schema": { "items": { "type": "string", "enum": ["inactive", "active"] } } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "slug": { "type": "string", "required": true, "description": "WordPress.org plugin directory slug." }, - "status": { "type": "string", "description": "The plugin activation status." } - }, - "required": ["slug"] - } - } - } - } - } - }, - "/wp/v2/plugins/{plugin}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "status": { "type": "string", "description": "The plugin activation status." } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "status": { "type": "string", "description": "The plugin activation status." } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - }, - "status": { "type": "string", "description": "The plugin activation status." } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plugin" } } } - } - }, - "parameters": [{ "name": "plugin", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "Scope under which the request is made; determines fields present in response." - } - } - } - } - } - } - } - }, - "/wp/v2/sidebars": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/sidebars/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of a registered sidebar", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "widgets": { "type": "array", "description": "Nested widgets." } } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "widgets": { "type": "array", "description": "Nested widgets." } } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sidebar" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { "widgets": { "type": "array", "description": "Nested widgets." } } - } - } - } - } - } - }, - "/wp/v2/widget-types": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/widget-types/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget-type" } } } - } - }, - "parameters": [ - { "name": "id", "in": "path", "description": "The widget type ID.", "required": true, "schema": {} }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/widget-types/{id}/encode": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "id", "in": "path", "description": "The widget type ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "instance": { "type": "object", "description": "Current instance settings of the widget." }, - "form_data": { - "type": "string", - "description": "Serialised widget form data to encode into instance settings." - } - } - } - } - } - } - } - }, - "/wp/v2/widget-types/{id}/render": { - "post": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "id", "in": "path", "description": "The widget type ID.", "required": true, "schema": {} } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "instance": { "type": "object", "description": "Current instance settings of the widget." } - } - } - } - } - } - } - }, - "/wp/v2/widgets": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "sidebar", - "in": "query", - "description": "The sidebar for which to return widgets.", - "required": false, - "schema": {} - } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id": { "type": "string", "description": "Unique identifier for the widget." }, - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { - "type": "string", - "required": true, - "description": "The sidebar to which the widget belongs." - }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - }, - "required": ["sidebar"] - } - } - } - } - } - }, - "/wp/v2/widgets/{id}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "id", "in": "path", "description": "", "required": true, "schema": {} } - ] - }, - "post": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the widget.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { "type": "string", "description": "The sidebar to which the widget belongs." }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - } - } - } - } - } - }, - "put": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the widget.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { "type": "string", "description": "The sidebar to which the widget belongs." }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - } - } - } - } - } - }, - "patch": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Unique identifier for the widget.", - "required": true, - "schema": {} - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "id_base": { - "type": "string", - "description": "The type of the widget. Corresponds to ID in widget-types endpoint." - }, - "sidebar": { "type": "string", "description": "The sidebar to which the widget belongs." }, - "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, - "form_data": { - "type": "string", - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." - } - } - } - } - } - } - }, - "delete": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/widget" } } } - } - }, - "parameters": [{ "name": "id", "in": "path", "description": "", "required": true, "schema": {} }], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "force": { - "type": "boolean", - "description": "Whether to force removal of the widget, or move it to the inactive sidebar." - } - } - } - } - } - } - } - }, - "/wp/v2/block-directory/search": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-directory-item" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "term", - "in": "query", - "description": "Limit result set to blocks matching the search term.", - "required": true, - "schema": { "minLength": 1 } - } - ] - } - }, - "/wp/v2/pattern-directory/patterns": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/pattern-directory-item" } } - } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - }, - { - "name": "search", - "in": "query", - "description": "Limit results to those matching a string.", - "required": false, - "schema": { "minLength": 1 } - }, - { - "name": "category", - "in": "query", - "description": "Limit results to those matching a category ID.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "keyword", - "in": "query", - "description": "Limit results to those matching a keyword ID.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "slug", - "in": "query", - "description": "Limit results to those matching a pattern (slug).", - "required": false, - "schema": {} - }, - { - "name": "offset", - "in": "query", - "description": "Offset the result set by a specific number of items.", - "required": false, - "schema": {} - }, - { - "name": "order", - "in": "query", - "description": "Order sort attribute ascending or descending.", - "required": false, - "schema": { "enum": ["asc", "desc"] } - }, - { - "name": "orderby", - "in": "query", - "description": "Sort collection by post attribute.", - "required": false, - "schema": { - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "favorite_count" - ] - } - } - ] - } - }, - "/wp/v2/block-patterns/patterns": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern" } } } - } - } - } - }, - "/wp/v2/block-patterns/categories": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/block-pattern-category" } } - } - } - } - } - }, - "/wp/v2/menu-locations": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/menu-locations/{location}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/menu-location" } } } - } - }, - "parameters": [ - { - "name": "location", - "in": "path", - "description": "An alphanumeric identifier for the menu location.", - "required": true, - "schema": {} - }, - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - } - ] - } - }, - "/wp/v2/font-collections": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { - "name": "page", - "in": "query", - "description": "Current page of the collection.", - "required": false, - "schema": { "minimum": 1 } - }, - { - "name": "per_page", - "in": "query", - "description": "Maximum number of items to be returned in result set.", - "required": false, - "schema": { "minimum": 1, "maximum": 100 } - } - ] - } - }, - "/wp/v2/font-collections/{slug}": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/font-collection" } } } - } - }, - "parameters": [ - { - "name": "context", - "in": "query", - "description": "Scope under which the request is made; determines fields present in response.", - "required": false, - "schema": { "enum": ["view", "embed", "edit"] } - }, - { "name": "slug", "in": "path", "description": "", "required": true, "schema": {} } - ] - } - }, "/wp-site-health/v1": { "get": { - "responses": { "200": { "description": "OK" } }, "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp-site-health/v1/tests/background-updates": { - "get": { + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } + "description": "OK" } } } }, - "/wp-site-health/v1/tests/loopback-requests": { + "/wp-site-health/v1/directory-sizes": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } - } - } - } - }, - "/wp-site-health/v1/tests/https-status": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } - } - } - } - }, - "/wp-site-health/v1/tests/dotorg-communication": { - "get": { - "responses": { - "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wp-site-health-test" } } } + "description": "OK" } } } @@ -66409,47 +88571,16886 @@ "get": { "responses": { "200": { - "description": "OK", - "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/directory-sizes": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wp-site-health/v1/tests/page-cache": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wp-block-editor/v1": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { "name": "namespace", "in": "query", "description": "", "required": false, "schema": {} }, - { "name": "context", "in": "query", "description": "", "required": false, "schema": {} } - ] - } - }, - "/wp-block-editor/v1/url-details": { - "get": { - "responses": { "200": { "description": "OK" } }, - "parameters": [ - { - "name": "url", - "in": "query", - "description": "The URL to process.", - "required": true, - "schema": { "format": "uri" } - } - ] - } - }, - "/wp-block-editor/v1/export": { "get": { "responses": { "200": { "description": "OK" } } } }, - "/wp-block-editor/v1/navigation-fallback": { + "/wp-site-health/v1/tests/background-updates": { "get": { "responses": { "200": { - "description": "OK", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/navigation-fallback" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/dotorg-communication": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/https-status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp-site-health-test" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp-site-health/v1/tests/loopback-requests": { + "get": { + "responses": { + "200": { + "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/v2": { + "get": { + "parameters": [ + { + "description": "", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + }, + { + "description": "", + "in": "query", + "name": "context", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/block-directory/search": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "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 result set to blocks matching the search term.", + "in": "query", + "name": "term", + "required": true, + "schema": { + "minLength": 1 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-directory-item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-patterns/categories": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern-category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-patterns/patterns": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-pattern" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-renderer/{name}": { + "get": { + "parameters": [ + { + "description": "Unique registered name for the block.", + "in": "path", + "name": "name", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit" + ] + } + }, + { + "description": "Attributes for the block.", + "in": "query", + "name": "attributes", + "required": false, + "schema": {} + }, + { + "description": "ID of the post context.", + "in": "query", + "name": "post_id", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique registered name for the block.", + "in": "path", + "name": "name", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rendered-block" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-types": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Block namespace.", + "in": "query", + "name": "namespace", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/block-types/{namespace}": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Block namespace.", + "in": "path", + "name": "namespace", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/block-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", + "in": "query", + "name": "wp_pattern_category", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", + "in": "query", + "name": "wp_pattern_category_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/blocks/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_block-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/categories": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific parent.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/categories/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/comments": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to comments published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + } + }, + { + "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", + "in": "query", + "name": "author_exclude", + "required": false, + "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" + } + }, + { + "description": "Limit response to comments published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "schema": { + "format": "date-time" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by comment attribute.", + "in": "query", + "name": "orderby", + "required": false, + "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" + } + } + }, + { + "description": "Ensure result set excludes specific parent IDs.", + "in": "query", + "name": "parent_exclude", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to comments assigned a specific status. Requires authorisation.", + "in": "query", + "name": "status", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to comments assigned a specific type. Requires authorisation.", + "in": "query", + "name": "type", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/comments/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "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" + }, + "password": { + "description": "The password for the parent post of the comment (if the post is password protected).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "The password for the parent post of the comment (if the post is password protected).", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the comment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/comment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-collections": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-collections/{slug}": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "slug", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/font-collection" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "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" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families/{font_family_id}/font-faces": { + "get": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_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": [ + "edit", + "embed", + "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": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "id", + "include" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_face_settings": { + "description": "font-face declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_face_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families/{font_family_id}/font-faces/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the font face.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent font family of the font face.", + "in": "path", + "name": "font_family_id", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the font face.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_face" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/font-families/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "description": "Version of the theme.json schema used for the typography settings.", + "type": "integer" + } + }, + "required": [ + "font_family_settings" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_font_family" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/themes/{stylesheet}": { + "get": { + "parameters": [ + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/themes/{stylesheet}/variations": { + "get": { + "parameters": [ + { + "description": "The theme identifier", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/{id}": { + "get": { + "parameters": [ + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "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" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "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" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/global-styles/{parent}/revisions/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the global styles revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the global styles revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_global_styles-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/media": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit result set to posts assigned to specific authors.", + "in": "query", + "name": "author", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to items with particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to attachments of a particular media type.", + "in": "query", + "name": "media_type", + "required": false, + "schema": { + "enum": [ + "application", + "image", + "video" + ] + } + }, + { + "description": "Limit result set to attachments of a particular MIME type.", + "in": "query", + "name": "mime_type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/media/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "alt_text": { + "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" + }, + "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": [ + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/attachment" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/media/{id}/edit": { + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "height": { + "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" + }, + "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" + }, + "width": { + "description": "As a percentage of the image, the width to which to crop the image. DEPRECATED: use `modifiers` instead.", + "type": "number" + }, + "x": { + "description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead.", + "type": "number" + }, + "y": { + "description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead.", + "type": "number" + } + }, + "required": [ + "src" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/media/{id}/post-process": { + "post": { + "parameters": [ + { + "description": "Unique identifier for the attachment.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "action": { + "required": true, + "type": "string" + } + }, + "required": [ + "action" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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": [ + "author", + "date", + "id", + "include", + "include_slugs", + "menu_order", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", + "in": "query", + "name": "menus", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", + "in": "query", + "name": "menus_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to posts with a specific menu_order value.", + "in": "query", + "name": "menu_order", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "attr_title": { + "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" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "type": "string" + }, + "object_id": { + "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" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "type": "string" + }, + "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" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-items/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu_item-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-locations": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menu-locations/{location}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the menu location.", + "in": "path", + "name": "location", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/menu-location" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menus": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/menus/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "auto_add": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nav_menu" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/navigation/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_navigation-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit result set to posts assigned to specific authors.", + "in": "query", + "name": "author", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to posts with a specific menu_order value.", + "in": "query", + "name": "menu_order", + "required": false, + "schema": {} + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "menu_order", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Limit result set to items with particular parent IDs.", + "in": "query", + "name": "parent", + "required": false, + "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" + } + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "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" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pages/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/pattern-directory/patterns": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": { + "minLength": 1 + } + }, + { + "description": "Limit results to those matching a category ID.", + "in": "query", + "name": "category", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Limit results to those matching a keyword ID.", + "in": "query", + "name": "keyword", + "required": false, + "schema": { + "minimum": 1 + } + }, + { + "description": "Limit results to those matching a pattern (slug).", + "in": "query", + "name": "slug", + "required": false, + "schema": {} + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "favorite_count", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pattern-directory-item" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/plugins": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limits results to plugins with the given status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "required": [ + "slug" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/plugins/{plugin}": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "plugin", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "status": { + "description": "The plugin activation status.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/plugin" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit result set to posts assigned to specific authors.", + "in": "query", + "name": "author", + "required": false, + "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" + } + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", + "in": "query", + "name": "categories", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", + "in": "query", + "name": "categories_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", + "in": "query", + "name": "tags", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", + "in": "query", + "name": "tags_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items that are sticky.", + "in": "query", + "name": "sticky", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "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" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "type": "string" + }, + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "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" + }, + "tags": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{parent}/revisions": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/posts/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "The ID for the parent of the revision.", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/post-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "in": "query", + "name": "after", + "required": false, + "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" + } + }, + { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "in": "query", + "name": "before", + "required": false, + "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" + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by post attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "popularity", + "popularity", + "rating", + "rating", + "relevance", + "slug", + "title" + ] + } + }, + { + "description": "Array of column names to be searched.", + "in": "query", + "name": "search_columns", + "required": false, + "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" + } + } + }, + { + "description": "Limit result set to posts assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + } + } + }, + { + "description": "Limit result set based on relationship between multiple taxonomies.", + "in": "query", + "name": "tax_relation", + "required": false, + "schema": { + "enum": [ + "AND", + "OR" + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", + "in": "query", + "name": "product_cat", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", + "in": "query", + "name": "product_cat_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", + "in": "query", + "name": "product_tag", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + }, + { + "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", + "in": "query", + "name": "product_tag_exclude", + "required": false, + "schema": { + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "content": { + "description": "The content for the post.", + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Override the default excerpt length.", + "in": "query", + "name": "excerpt_length", + "required": false, + "schema": {} + }, + { + "description": "The password for the post if it is password protected.", + "in": "query", + "name": "password", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the post.", + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product/{id}/autosaves": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "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" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "type": "array" + }, + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product/{parent}/autosaves/{id}": { + "get": { + "parameters": [ + { + "description": "The ID for the parent of the autosave.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product-revision" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_cat": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific parent.", + "in": "query", + "name": "parent", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_cat/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_cat" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_tag": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/product_tag/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/search": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Limit results to items of an object type.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "enum": [ + "post", + "post-format", + "term" + ] + } + }, + { + "description": "Limit results to items of one or more object subtypes.", + "in": "query", + "name": "subtype", + "required": false, + "schema": { + "items": { + "enum": [ + "any", + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], + "type": "string" + } + } + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/search-result" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/settings": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "requestBody": { + "content": { + "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" + }, + "default_comment_status": { + "description": "Allow people to submit comments on new posts.", + "type": "string" + }, + "default_ping_status": { + "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" + }, + "email": { + "description": "This address is used for admin purposes, like new user notification.", + "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" + }, + "page_on_front": { + "description": "The ID of the page that should be displayed on the front page", + "type": "integer" + }, + "pickup_location_settings": { + "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" + }, + "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" + }, + "use_smilies": { + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "default_comment_status": { + "description": "Allow people to submit comments on new posts.", + "type": "string" + }, + "default_ping_status": { + "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" + }, + "email": { + "description": "This address is used for admin purposes, like new user notification.", + "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" + }, + "page_on_front": { + "description": "The ID of the page that should be displayed on the front page", + "type": "integer" + }, + "pickup_location_settings": { + "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" + }, + "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" + }, + "use_smilies": { + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + }, + "default_comment_status": { + "description": "Allow people to submit comments on new posts.", + "type": "string" + }, + "default_ping_status": { + "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" + }, + "email": { + "description": "This address is used for admin purposes, like new user notification.", + "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" + }, + "page_on_front": { + "description": "The ID of the page that should be displayed on the front page", + "type": "integer" + }, + "pickup_location_settings": { + "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" + }, + "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" + }, + "use_smilies": { + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/settings" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/sidebars": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/sidebars/{id}": { + "get": { + "parameters": [ + { + "description": "The ID of a registered sidebar", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "widgets": { + "description": "Nested widgets.", + "type": "array" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sidebar" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/statuses": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/statuses/{status}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the status.", + "in": "path", + "name": "status", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/tags": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/tags/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tag" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/taxonomies": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit results to taxonomies associated with a specific post type.", + "in": "query", + "name": "type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/taxonomies/{taxonomy}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the taxonomy.", + "in": "path", + "name": "taxonomy", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taxonomy" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit to the specified post ID.", + "in": "query", + "name": "wp_id", + "required": false, + "schema": {} + }, + { + "description": "Limit to the specified template part area.", + "in": "query", + "name": "area", + "required": false, + "schema": {} + }, + { + "description": "Post type for which to get the templates.", + "in": "query", + "name": "post_type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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.", + "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" + } + }, + "required": [ + "slug" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/lookup": { + "get": { + "parameters": [ + { + "description": "The slug of the template to get the fallback for", + "in": "query", + "name": "slug", + "required": true, + "schema": {} + }, + { + "description": "Indicates if a template is custom or part of the template hierarchy", + "in": "query", + "name": "is_custom", + "required": false, + "schema": {} + }, + { + "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", + "in": "query", + "name": "template_prefix", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{id}": { + "delete": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{id}/autosaves": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "area": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{parent}/revisions": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/template-parts/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template_part" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "Limit to the specified post ID.", + "in": "query", + "name": "wp_id", + "required": false, + "schema": {} + }, + { + "description": "Limit to the specified template part area.", + "in": "query", + "name": "area", + "required": false, + "schema": {} + }, + { + "description": "Post type for which to get the templates.", + "in": "query", + "name": "post_type", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "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.", + "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" + } + }, + "required": [ + "slug" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/lookup": { + "get": { + "parameters": [ + { + "description": "The slug of the template to get the fallback for", + "in": "query", + "name": "slug", + "required": true, + "schema": {} + }, + { + "description": "Indicates if a template is custom or part of the template hierarchy", + "in": "query", + "name": "is_custom", + "required": false, + "schema": {} + }, + { + "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", + "in": "query", + "name": "template_prefix", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{id}": { + "delete": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{id}/autosaves": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "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": {} + } + ], + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{parent}/revisions": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "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", + "id", + "include", + "include_slugs", + "relevance", + "slug", + "title" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/templates/{parent}/revisions/{id}": { + "delete": { + "parameters": [ + { + "description": "The ID of a template", + "in": "path", + "name": "parent", + "required": true, + "schema": {} + }, + { + "description": "Unique identifier for the revision.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as revisions do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": "Unique identifier for the revision.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_template" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/themes": { + "get": { + "parameters": [ + { + "description": "Limit result set to themes assigned one or more statuses.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/themes/{stylesheet}": { + "get": { + "parameters": [ + { + "description": "The theme's style sheet. This uniquely identifies the theme.", + "in": "path", + "name": "stylesheet", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/theme" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/types": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/types/{type}": { + "get": { + "parameters": [ + { + "description": "An alphanumeric identifier for the post type.", + "in": "path", + "name": "type", + "required": true, + "schema": {} + }, + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by user attribute.", + "in": "query", + "name": "orderby", + "required": false, + "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" + } + } + }, + { + "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" + } + } + }, + { + "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" + } + } + }, + { + "description": "Limit result set to users who are considered authors.", + "in": "query", + "name": "who", + "required": false, + "schema": { + "enum": [ + "authors" + ] + } + }, + { + "description": "Limit result set to users who have published posts.", + "in": "query", + "name": "has_published_posts", + "required": false, + "schema": { + "items": { + "enum": { + "attachment": "attachment", + "nav_menu_item": "nav_menu_item", + "page": "page", + "post": "post", + "product": "product", + "wp_block": "wp_block", + "wp_font_face": "wp_font_face", + "wp_font_family": "wp_font_family", + "wp_global_styles": "wp_global_styles", + "wp_navigation": "wp_navigation", + "wp_template": "wp_template", + "wp_template_part": "wp_template_part" + }, + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "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" + } + }, + "required": [ + "email", + "password", + "username" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/me": { + "delete": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as users do not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "Reassign the deleted user's posts and links to this user ID.", + "required": true, + "type": "integer" + } + }, + "required": [ + "reassign" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as users do not support binning.", + "type": "boolean" + }, + "reassign": { + "description": "Reassign the deleted user's posts and links to this user ID.", + "required": true, + "type": "integer" + } + }, + "required": [ + "reassign" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the user.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/{user_id}/application-passwords": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/users/{user_id}/application-passwords/introspect": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + } + }, + "/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": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "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" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "user_id", + "required": true, + "schema": {} + }, + { + "description": "", + "in": "path", + "name": "uuid", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "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": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "app_id": { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/application-password" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types/{id}": { + "get": { + "parameters": [ + { + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget-type" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types/{id}/encode": { + "post": { + "parameters": [ + { + "description": "The widget type ID.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "description": "Serialised widget form data to encode into instance settings.", + "type": "string" + }, + "instance": { + "description": "Current instance settings of the widget.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/widget-types/{id}/render": { + "post": { + "parameters": [ + { + "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" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/wp/v2/widgets": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "The sidebar for which to return widgets.", + "in": "query", + "name": "sidebar", + "required": false, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "required": true, + "type": "string" + } + }, + "required": [ + "sidebar" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/widgets/{id}": { + "delete": { + "parameters": [ + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Whether to force removal of the widget, or move it to the inactive sidebar.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "view" + ] + } + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the widget.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the widget.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the widget.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "form_data": { + "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_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" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/widget" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/wp_pattern_category": { + "get": { + "parameters": [ + { + "description": "Scope under which the request is made; determines fields present in response.", + "in": "query", + "name": "context", + "required": false, + "schema": { + "enum": [ + "edit", + "embed", + "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 results to those matching a string.", + "in": "query", + "name": "search", + "required": false, + "schema": {} + }, + { + "description": "Ensure result set excludes specific IDs.", + "in": "query", + "name": "exclude", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Limit result set to specific IDs.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "type": "integer" + } + } + }, + { + "description": "Offset the result set by a specific number of items.", + "in": "query", + "name": "offset", + "required": false, + "schema": {} + }, + { + "description": "Order sort attribute ascending or descending.", + "in": "query", + "name": "order", + "required": false, + "schema": { + "enum": [ + "asc", + "desc" + ] + } + }, + { + "description": "Sort collection by term attribute.", + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ] + } + }, + { + "description": "Whether to hide terms not assigned to any posts.", + "in": "query", + "name": "hide_empty", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms assigned to a specific post.", + "in": "query", + "name": "post", + "required": false, + "schema": {} + }, + { + "description": "Limit result set to terms with one or more specific slugs.", + "in": "query", + "name": "slug", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + } + }, + "/wp/v2/wp_pattern_category/{id}": { + "delete": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "force": { + "description": "Required to be true, as terms do not support binning.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "get": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "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": [ + "edit", + "embed", + "view" + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "patch": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "post": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" + } + } + }, + "put": { + "parameters": [ + { + "description": "Unique identifier for the term.", + "in": "path", + "name": "id", + "required": true, + "schema": {} + } + ], + "requestBody": { + "content": { + "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" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/wp_pattern_category" + } + } + }, + "description": "OK" } } } } - } + }, + "security": [], + "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" + } + ] } diff --git a/lib/wp-json-schema.json b/lib/wp-json-schema.json index 67f1db79..ad87d7d6 100755 --- a/lib/wp-json-schema.json +++ b/lib/wp-json-schema.json @@ -1,87973 +1,88437 @@ { - "name": "Haiku Atelier", + "_links": { + "help": [ + { + "href": "https://developer.wordpress.org/rest-api/" + } + ] + }, + "authentication": [], "description": "", - "url": "https://haikuatelier.fr.ddev.site/wp", - "home": "https://haikuatelier.fr.ddev.site", "gmt_offset": 2, - "timezone_string": "Europe/Brussels", + "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" ], - "authentication": [], "routes": { "/": { - "namespace": "", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "default": "view", - "required": false - } - } - } - ], "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/" } ] - } - }, - "/batch/v1": { - "namespace": "", - "methods": [ - "POST" - ], + }, "endpoints": [ { - "methods": [ - "POST" - ], "args": { - "validation": { - "type": "string", - "enum": [ - "require-all-validate", - "normal" - ], - "default": "normal", + "context": { + "default": "view", "required": false - }, - "requests": { - "type": "array", - "maxItems": 25, - "items": { - "type": "object", - "properties": { - "method": { - "type": "string", - "enum": [ - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "default": "POST" - }, - "path": { - "type": "string", - "required": true - }, - "body": { - "type": "object", - "properties": [], - "additionalProperties": true - }, - "headers": { - "type": "object", - "properties": [], - "additionalProperties": { - "type": [ - "string", - "array" - ], - "items": { - "type": "string" - } - } - } - } - }, - "required": true } - } + }, + "methods": [ + "GET" + ] } ], + "methods": [ + "GET" + ], + "namespace": "" + }, + "/batch/v1": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/batch/v1" } ] - } - }, - "/wc/v3": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], + }, "endpoints": [ { - "methods": [ - "GET" - ], "args": { - "namespace": { - "default": "wc/v3", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3" - } - ] - } - }, - "/wc/v3/marketplace/featured": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/featured" - } - ] - } - }, - "/wc/v3/marketplace/refresh": { - "namespace": "wc/v3", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/refresh" - } - ] - } - }, - "/wc/v3/marketplace/subscriptions": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions" - } - ] - } - }, - "/wc/v3/marketplace/subscriptions/connect": { - "namespace": "wc/v3", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "product_key": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/connect" - } - ] - } - }, - "/wc/v3/marketplace/subscriptions/disconnect": { - "namespace": "wc/v3", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "product_key": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/disconnect" - } - ] - } - }, - "/wc/v3/marketplace/subscriptions/activate": { - "namespace": "wc/v3", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "product_key": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/activate" - } - ] - } - }, - "/wc/v3/marketplace/subscriptions/install-url": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_key": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/install-url" - } - ] - } - }, - "/wc/v3/marketplace/create-order": { - "namespace": "wc/v3", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/create-order" - } - ] - } - }, - "/jetpack/v4": { - "namespace": "jetpack/v4", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "jetpack/v4", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4" - } - ] - } - }, - "/jetpack/v4/verify_xmlrpc_error": { - "namespace": "jetpack/v4", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "nonce": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_xmlrpc_error" - } - ] - } - }, - "/jetpack/v4/verify_registration": { - "namespace": "jetpack/v4", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_registration" - } - ] - } - }, - "/jetpack/v4/remote_authorize": { - "namespace": "jetpack/v4", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/remote_authorize" - } - ] - } - }, - "/jetpack/v4/connection": { - "namespace": "jetpack/v4", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "isActive": { - "description": "Set to false will trigger the site to disconnect.", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection" - } - ] - } - }, - "/jetpack/v4/connection/data": { - "namespace": "jetpack/v4", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/data" - } - ] - } - }, - "/jetpack/v4/connection/plugins": { - "namespace": "jetpack/v4", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/plugins" - } - ] - } - }, - "/jetpack/v4/connection/reconnect": { - "namespace": "jetpack/v4", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/reconnect" - } - ] - } - }, - "/jetpack/v4/connection/register": { - "namespace": "jetpack/v4", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "from": { - "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", - "type": "string", - "required": false - }, - "registration_nonce": { - "description": "The registration nonce", - "type": "string", - "required": true - }, - "redirect_uri": { - "description": "URI of the admin page where the user should be redirected after connection flow", - "type": "string", - "required": false - }, - "plugin_slug": { - "description": "Indicates from what plugin the request is coming from", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/register" - } - ] - } - }, - "/jetpack/v4/connection/authorize_url": { - "namespace": "jetpack/v4", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "redirect_uri": { - "description": "URI of the admin page where the user should be redirected after connection flow", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/authorize_url" - } - ] - } - }, - "/jetpack/v4/user-token": { - "namespace": "jetpack/v4", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "user_token": { - "description": "New user token", - "type": "string", - "required": true - }, - "is_connection_owner": { - "description": "Is connection owner", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/user-token" - } - ] - } - }, - "/jetpack/v4/connection/owner": { - "namespace": "jetpack/v4", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "owner": { - "description": "New owner", - "type": "integer", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/owner" - } - ] - } - }, - "/wc-admin": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc-admin", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin" - } - ] - } - }, - "/wc-admin/notice/dismiss": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/notice/dismiss" - } - ] - } - }, - "/wc-admin/features": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/features" - } - ] - } - }, - "/wc-admin/experiments/assignment": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/experiments/assignment" - } - ] - } - }, - "/wc-admin/marketing/recommended": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "category": { - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommended" - } - ] - } - }, - "/wc-admin/marketing/knowledge-base": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "category": { - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/knowledge-base" - } - ] - } - }, - "/wc-admin/marketing/overview/activate-plugin": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "plugin": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/activate-plugin" - } - ] - } - }, - "/wc-admin/marketing/overview/installed-plugins": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/installed-plugins" - } - ] - } - }, - "/wc-admin/marketing/recommendations": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "category": { - "type": "string", - "enum": [ - "channels", - "extensions" - ], - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommendations" - } - ] - } - }, - "/wc-admin/marketing/channels": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/channels" - } - ] - } - }, - "/wc-admin/marketing/campaigns": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaigns" - } - ] - } - }, - "/wc-admin/marketing/campaign-types": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaign-types" - } - ] - } - }, - "/wc-admin/options": { - "namespace": "wc-admin", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/options" - } - ] - } - }, - "/wc-admin/payment-gateway-suggestions": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "force_default_suggestions": { - "type": "boolean", - "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions" - } - ] - } - }, - "/wc-admin/payment-gateway-suggestions/dismiss": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions/dismiss" - } - ] - } - }, - "/wc-admin/themes": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "pluginzip": { - "description": "A zip file of the theme to be uploaded.", - "type": "file", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/themes" - } - ] - } - }, - "/wc-admin/plugins/install": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install" - } - ] - } - }, - "/wc-admin/plugins/install/status": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install/status" - } - ] - } - }, - "/wc-admin/plugins/install/status/(?P\u003Cjob_id\u003E[a-z0-9_\\-]+)": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/wc-admin/plugins/active": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/active" - } - ] - } - }, - "/wc-admin/plugins/installed": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/installed" - } - ] - } - }, - "/wc-admin/plugins/activate": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate" - } - ] - } - }, - "/wc-admin/plugins/activate/status": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate/status" - } - ] - } - }, - "/wc-admin/plugins/activate/status/(?P\u003Cjob_id\u003E[a-z0-9_\\-]+)": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/wc-admin/plugins/connect-jetpack": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-jetpack" - } - ] - } - }, - "/wc-admin/plugins/request-wccom-connect": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/request-wccom-connect" - } - ] - } - }, - "/wc-admin/plugins/finish-wccom-connect": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/finish-wccom-connect" - } - ] - } - }, - "/wc-admin/plugins/connect-wcpay": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-wcpay" - } - ] - } - }, - "/wc-admin/plugins/connect-square": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-square" - } - ] - } - }, - "/wc-admin/onboarding/free-extensions": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/free-extensions" - } - ] - } - }, - "/wc-admin/onboarding/product-types": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/product-types" - } - ] - } - }, - "/wc-admin/onboarding/profile": { - "namespace": "wc-admin", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "completed": { - "type": "boolean", - "description": "Whether or not the profile was completed.", - "required": false - }, - "skipped": { - "type": "boolean", - "description": "Whether or not the profile was skipped.", - "required": false - }, - "industry": { - "type": "array", - "description": "Industry.", + "requests": { "items": { + "properties": { + "body": { + "additionalProperties": true, + "properties": [], + "type": "object" + }, + "headers": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": [ + "array", + "string" + ] + }, + "properties": [], + "type": "object" + }, + "method": { + "default": "POST", + "enum": [ + "DELETE", + "PATCH", + "POST", + "PUT" + ], + "type": "string" + }, + "path": { + "required": true, + "type": "string" + } + }, "type": "object" }, - "required": false - }, - "product_types": { - "type": "array", - "description": "Types of products sold.", - "items": { - "enum": [ - "physical", - "downloads", - "subscriptions", - "memberships", - "bookings", - "product-bundles", - "product-add-ons" - ], - "type": "string" - }, - "required": false - }, - "product_count": { - "type": "string", - "description": "Number of products to be added.", - "enum": [ - "0", - "1-10", - "11-100", - "101-1000", - "1000+" - ], - "required": false - }, - "selling_venues": { - "type": "string", - "description": "Other places the store is selling products.", - "enum": [ - "no", - "other", - "brick-mortar", - "brick-mortar-other", - "other-woocommerce" - ], - "required": false - }, - "number_employees": { - "type": "string", - "description": "Number of employees of the store.", - "enum": [ - "1", - "\u003C10", - "10-50", - "50-250", - "+250", - "not specified" - ], - "required": false - }, - "revenue": { - "type": "string", - "description": "Current annual revenue of the store.", - "enum": [ - "none", - "up-to-2500", - "2500-10000", - "10000-50000", - "50000-250000", - "more-than-250000", - "rather-not-say" - ], - "required": false - }, - "other_platform": { - "type": "string", - "description": "Name of other platform used to sell.", - "enum": [ - "shopify", - "bigcommerce", - "magento", - "wix", - "amazon", - "ebay", - "etsy", - "squarespace", - "other" - ], - "required": false - }, - "other_platform_name": { - "type": "string", - "description": "Name of other platform used to sell (not listed).", - "required": false - }, - "business_extensions": { - "type": "array", - "description": "Extra business extensions to install.", - "items": { - "type": "string" - }, - "required": false - }, - "theme": { - "type": "string", - "description": "Selected store theme.", - "required": false - }, - "setup_client": { - "type": "boolean", - "description": "Whether or not this store was setup for a client.", - "required": false - }, - "wccom_connected": { - "type": "boolean", - "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", - "required": false - }, - "is_agree_marketing": { - "type": "boolean", - "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", - "required": false - }, - "store_email": { - "type": "string", - "description": "Store email address.", - "required": false - }, - "is_store_country_set": { - "type": "boolean", - "description": "Whether or not this store country is set via onboarding profiler.", - "required": false - }, - "is_plugins_page_skipped": { - "type": "boolean", - "description": "Whether or not plugins step in core profiler was skipped.", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile" - } - ] - } - }, - "/wc-admin/onboarding/profile/experimental_get_email_prefill": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile/experimental_get_email_prefill" - } - ] - } - }, - "/wc-admin/onboarding/tasks/import_sample_products": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/import_sample_products" - } - ] - } - }, - "/wc-admin/onboarding/tasks/create_homepage": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_homepage" - } - ] - } - }, - "/wc-admin/onboarding/tasks/create_product_from_template": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "template_name": { - "type": "string", - "description": "Product template name.", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_product_from_template" - } - ] - } - }, - "/wc-admin/onboarding/tasks": { - "namespace": "wc-admin", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "ids": { - "description": "Optional parameter to get only specific task lists by ID.", - "type": "array", - "items": { - "enum": [ - "setup", - "extended", - "secret_tasklist" - ], - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "ids": { - "description": "Optional parameter to get only specific task lists by ID.", - "type": "array", - "items": { - "enum": [ - "setup", - "extended", - "secret_tasklist" - ], - "type": "string" - }, - "required": false - }, - "extended_tasks": { - "description": "List of extended deprecated tasks from the client-side filter.", - "type": "array", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks" - } - ] - } - }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/hide": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ] - }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/unhide": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ] - }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/dismiss": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ] - }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/undo_dismiss": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ] - }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_-]+)/snooze": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "duration": { - "description": "Time period to snooze the task.", - "type": "string", - "required": false - }, - "task_list_id": { - "description": "Optional parameter to query specific task list.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/action": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ] - }, - "/wc-admin/onboarding/tasks/(?P\u003Cid\u003E[a-z0-9_\\-]+)/undo_snooze": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ] - }, - "/wc-admin/onboarding/themes/install": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/install" - } - ] - } - }, - "/wc-admin/onboarding/themes/activate": { - "namespace": "wc-admin", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/activate" - } - ] - } - }, - "/wc-admin/onboarding/themes/recommended": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "industry": { - "type": "string", - "description": "Limits the results to themes relevant for this industry (optional)", - "required": false - }, - "currency": { - "type": "string", - "enum": [ - "USD", - "AUD", - "CAD", - "EUR", - "GBP" - ], - "default": "USD", - "description": "Returns pricing in this currency (optional, default: USD)", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/recommended" - } - ] - } - }, - "/wc-admin/onboarding/plugins/install-and-activate-async": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "plugins": { - "description": "A list of plugins to install", - "type": "array", - "items": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate-async" - } - ] - } - }, - "/wc-admin/onboarding/plugins/install-and-activate": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate" - } - ] - } - }, - "/wc-admin/onboarding/plugins/scheduled-installs/(?P\u003Cjob_id\u003E\\w+)": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/wc-admin/onboarding/plugins/jetpack-authorization-url": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "redirect_url": { - "description": "The URL to redirect to after authorization", - "type": "string", - "required": true - }, - "from": { - "description": "from value for the jetpack authorization page", - "type": "string", - "default": "woocommerce-onboarding", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/jetpack-authorization-url" - } - ] - } - }, - "/wc-admin/onboarding/products": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/products" - } - ] - } - }, - "/wc-admin/navigation/favorites/me": { - "namespace": "wc-admin", - "methods": [ - "GET", - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "POST" - ], - "args": { - "item_id": { - "required": true - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "item_id": { - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/navigation/favorites/me" - } - ] - } - }, - "/wc-admin/mobile-app/send-magic-link": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app/send-magic-link" - } - ] - } - }, - "/wc-admin/mobile-app": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app" - } - ] - } - }, - "/wc-admin/shipping-partner-suggestions": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "force_default_suggestions": { - "type": "boolean", - "description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/shipping-partner-suggestions" - } - ] - } - }, - "/wc-admin/launch-your-store/initialize-coming-soon": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/initialize-coming-soon" - } - ] - } - }, - "/wc-admin/launch-your-store/update-survey-status": { - "namespace": "wc-admin", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "status": { - "type": "string", - "enum": [ - "yes", - "no" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/update-survey-status" - } - ] - } - }, - "/wc-admin/launch-your-store/survey-completed": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/survey-completed" - } - ] - } - }, - "/wc-admin/launch-your-store/woopayments/test-orders/count": { - "namespace": "wc-admin", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders/count" - } - ] - } - }, - "/wc-admin/launch-your-store/woopayments/test-orders": { - "namespace": "wc-admin", - "methods": [ - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "DELETE" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders" - } - ] - } - }, - "/wc-analytics": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc-analytics", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics" - } - ] - } - }, - "/wc-analytics/customers": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date_registered", - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "registered_before": { - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "registered_after": { - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "search": { - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "type": "string", - "required": false - }, - "searchby": { - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "type": "string", - "default": "name", - "enum": [ - "name", - "username", - "email", - "all" - ], - "required": false - }, - "name_includes": { - "description": "Limit response to objects with specific names.", - "type": "string", - "required": false - }, - "name_excludes": { - "description": "Limit response to objects excluding specific names.", - "type": "string", - "required": false - }, - "username_includes": { - "description": "Limit response to objects with specific usernames.", - "type": "string", - "required": false - }, - "username_excludes": { - "description": "Limit response to objects excluding specific usernames.", - "type": "string", - "required": false - }, - "email_includes": { - "description": "Limit response to objects including emails.", - "type": "string", - "required": false - }, - "email_excludes": { - "description": "Limit response to objects excluding emails.", - "type": "string", - "required": false - }, - "country_includes": { - "description": "Limit response to objects with specific countries.", - "type": "string", - "required": false - }, - "country_excludes": { - "description": "Limit response to objects excluding specific countries.", - "type": "string", - "required": false - }, - "last_active_before": { - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_after": { - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "registered_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "orders_count_min": { - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_max": { - "description": "Limit response to objects with an order count less than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_between": { - "description": "Limit response to objects with an order count between two given integers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "total_spend_min": { - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_max": { - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_between": { - "description": "Limit response to objects with a total order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "avg_order_value_min": { - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "avg_order_value_max": { - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "type": "number", - "required": false - }, - "avg_order_value_between": { - "description": "Limit response to objects with an average order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "last_order_before": { - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_order_after": { - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "users": { - "description": "Limit result to items with specified user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "filter_empty": { - "description": "Filter out results where any of the passed fields are empty", - "type": "array", - "items": { - "type": "string", - "enum": [ - "email", - "name", - "country", - "city", - "state", - "postcode" - ] - }, - "required": false - }, - "include": { - "description": "Limit result to items with specified customer IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/customers" - } - ] - } - }, - "/wc-analytics/customers/(?P\u003Cid\u003E[\\d-]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date_registered", - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "registered_before": { - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "registered_after": { - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "search": { - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "type": "string", - "required": false - }, - "searchby": { - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "type": "string", - "default": "name", - "enum": [ - "name", - "username", - "email", - "all" - ], - "required": false - }, - "name_includes": { - "description": "Limit response to objects with specific names.", - "type": "string", - "required": false - }, - "name_excludes": { - "description": "Limit response to objects excluding specific names.", - "type": "string", - "required": false - }, - "username_includes": { - "description": "Limit response to objects with specific usernames.", - "type": "string", - "required": false - }, - "username_excludes": { - "description": "Limit response to objects excluding specific usernames.", - "type": "string", - "required": false - }, - "email_includes": { - "description": "Limit response to objects including emails.", - "type": "string", - "required": false - }, - "email_excludes": { - "description": "Limit response to objects excluding emails.", - "type": "string", - "required": false - }, - "country_includes": { - "description": "Limit response to objects with specific countries.", - "type": "string", - "required": false - }, - "country_excludes": { - "description": "Limit response to objects excluding specific countries.", - "type": "string", - "required": false - }, - "last_active_before": { - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_after": { - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "registered_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "orders_count_min": { - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_max": { - "description": "Limit response to objects with an order count less than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_between": { - "description": "Limit response to objects with an order count between two given integers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "total_spend_min": { - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_max": { - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_between": { - "description": "Limit response to objects with a total order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "avg_order_value_min": { - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "avg_order_value_max": { - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "type": "number", - "required": false - }, - "avg_order_value_between": { - "description": "Limit response to objects with an average order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "last_order_before": { - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_order_after": { - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "users": { - "description": "Limit result to items with specified user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "filter_empty": { - "description": "Filter out results where any of the passed fields are empty", - "type": "array", - "items": { - "type": "string", - "enum": [ - "email", - "name", - "country", - "city", - "state", - "postcode" - ] - }, - "required": false - }, - "include": { - "description": "Limit result to items with specified customer IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - } - ] - }, - "/wc-analytics/leaderboards": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 5, - "minimum": 1, - "maximum": 20, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "persisted_query": { - "description": "URL query to persist across links.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards" - } - ] - } - }, - "/wc-analytics/leaderboards/allowed": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards/allowed" - } - ] - } - }, - "/wc-analytics/leaderboards/(?P\u003Cleaderboard\u003E\\w+)": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "leaderboard": { - "type": "string", - "enum": [ - "customers", - "coupons", - "categories", - "products" - ], - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 5, - "minimum": 1, - "maximum": 20, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "persisted_query": { - "description": "URL query to persist across links.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc-analytics/reports": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports" - } - ] - } - }, - "/wc-analytics/reports/import": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "days": { - "description": "Number of days to import.", - "type": "integer", - "minimum": 0, - "required": false - }, - "skip_existing": { - "description": "Skip importing existing order data.", - "type": "boolean", - "default": false, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import" - } - ] - } - }, - "/wc-analytics/reports/import/cancel": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/cancel" - } - ] - } - }, - "/wc-analytics/reports/import/delete": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/delete" - } - ] - } - }, - "/wc-analytics/reports/import/status": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/status" - } - ] - } - }, - "/wc-analytics/reports/import/totals": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "days": { - "description": "Number of days to import.", - "type": "integer", - "minimum": 0, - "required": false - }, - "skip_existing": { - "description": "Skip importing existing order data.", - "type": "boolean", - "default": false, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/totals" - } - ] - } - }, - "/wc-analytics/reports/(?P\u003Ctype\u003E[a-z]+)/export": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "report_args": { - "description": "Parameters to pass on to the exported report.", - "type": "object", - "required": false - }, - "email": { - "description": "When true, email a link to download the export to the requesting user.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc-analytics/reports/(?P\u003Ctype\u003E[a-z]+)/export/(?P\u003Cexport_id\u003E[a-z0-9]+)/status": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/wc-analytics/reports/products": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "net_revenue", - "orders_count", - "items_sold", - "product_name", - "variations", - "sku" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "categories": { - "description": "Limit result to items from the specified categories.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "products": { - "description": "Limit result to items with specified product IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "extended_info": { - "description": "Add additional piece of info about each product to the report.", - "type": "boolean", - "default": false, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products" - } - ] - } - }, - "/wc-analytics/reports/variations": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "net_revenue", - "orders_count", - "items_sold", - "sku" - ], - "required": false - }, - "product_includes": { - "description": "Limit result set to items that have the specified parent product(s).", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "product_excludes": { - "description": "Limit result set to items that don't have the specified parent product(s).", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "variations": { - "description": "Limit result to items with specified variation IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "extended_info": { - "description": "Add additional piece of info about each variation to the report.", - "type": "boolean", - "default": false, - "required": false - }, - "attribute_is": { - "description": "Limit result set to variations that include the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - }, - "attribute_is_not": { - "description": "Limit result set to variations that don't include the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - }, - "category_includes": { - "description": "Limit result set to variations in the specified categories.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "category_excludes": { - "description": "Limit result set to variations not in the specified categories.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "products": { - "description": "Limit result to items with specified product IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations" - } - ] - } - }, - "/wc-analytics/reports/products/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "categories": { - "description": "Limit result to items from the specified categories.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "products": { - "description": "Limit result to items with specified product IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "variations": { - "description": "Limit result to items with specified variation IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "segmentby": { - "description": "Segment the response by additional constraint.", - "type": "string", - "enum": [ - "product", - "category", - "variation" - ], - "required": false - }, - "fields": { - "description": "Limit stats fields to the specified items.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products/stats" - } - ] - } - }, - "/wc-analytics/reports/variations/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "net_revenue", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "category_includes": { - "description": "Limit result to items from the specified categories.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "category_excludes": { - "description": "Limit result set to variations not in the specified categories.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "product_includes": { - "description": "Limit result set to items that have the specified parent product(s).", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "product_excludes": { - "description": "Limit result set to items that don't have the specified parent product(s).", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "variations": { - "description": "Limit result to items with specified variation IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "segmentby": { - "description": "Segment the response by additional constraint.", - "type": "string", - "enum": [ - "product", - "category", - "variation" - ], - "required": false - }, - "fields": { - "description": "Limit stats fields to the specified items.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "attribute_is": { - "description": "Limit result set to orders that include products with the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - }, - "attribute_is_not": { - "description": "Limit result set to orders that don't include products with the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations/stats" - } - ] - } - }, - "/wc-analytics/reports/revenue/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "total_sales", - "coupons", - "refunds", - "shipping", - "taxes", - "net_revenue", - "orders_count", - "items_sold", - "gross_sales" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "segmentby": { - "description": "Segment the response by additional constraint.", - "type": "string", - "enum": [ - "product", - "category", - "variation", - "coupon", - "customer_type" - ], - "required": false - }, - "date_type": { - "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", - "type": "string", - "enum": [ - "date_paid", - "date_created", - "date_completed" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/revenue/stats" - } - ] - } - }, - "/wc-analytics/reports/orders": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 0, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "num_items_sold", - "net_total" - ], - "required": false - }, - "product_includes": { - "description": "Limit result set to items that have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "product_excludes": { - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "variation_includes": { - "description": "Limit result set to items that have the specified variation(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "variation_excludes": { - "description": "Limit result set to items that don't have the specified variation(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "coupon_includes": { - "description": "Limit result set to items that have the specified coupon(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "coupon_excludes": { - "description": "Limit result set to items that don't have the specified coupon(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "tax_rate_includes": { - "description": "Limit result set to items that have the specified tax rate(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "tax_rate_excludes": { - "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "status_is": { - "description": "Limit result set to items that have the specified order status.", - "type": "array", - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - }, - "required": false - }, - "status_is_not": { - "description": "Limit result set to items that don't have the specified order status.", - "type": "array", - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - }, - "required": false - }, - "customer_type": { - "description": "Limit result set to returning or new customers.", - "type": "string", - "default": "", - "enum": [ - "", - "returning", - "new" - ], - "required": false - }, - "refunds": { - "description": "Limit result set to specific types of refunds.", - "type": "string", - "default": "", - "enum": [ - "", - "all", - "partial", - "full", - "none" - ], - "required": false - }, - "extended_info": { - "description": "Add additional piece of info about each coupon to the report.", - "type": "boolean", - "default": false, - "required": false - }, - "order_includes": { - "description": "Limit result set to items that have the specified order IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "order_excludes": { - "description": "Limit result set to items that don't have the specified order IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "attribute_is": { - "description": "Limit result set to orders that include products with the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - }, - "attribute_is_not": { - "description": "Limit result set to orders that don't include products with the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders" - } - ] - } - }, - "/wc-analytics/reports/orders/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "net_revenue", - "orders_count", - "avg_order_value" - ], - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "status_is": { - "description": "Limit result set to items that have the specified order status.", - "type": "array", - "default": null, - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - }, - "required": false - }, - "status_is_not": { - "description": "Limit result set to items that don't have the specified order status.", - "type": "array", - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - }, - "required": false - }, - "product_includes": { - "description": "Limit result set to items that have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "product_excludes": { - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "variation_includes": { - "description": "Limit result set to items that have the specified variation(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "variation_excludes": { - "description": "Limit result set to items that don't have the specified variation(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "coupon_includes": { - "description": "Limit result set to items that have the specified coupon(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "coupon_excludes": { - "description": "Limit result set to items that don't have the specified coupon(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "tax_rate_includes": { - "description": "Limit result set to items that have the specified tax rate(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "tax_rate_excludes": { - "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "customer": { - "description": "Alias for customer_type (deprecated).", - "type": "string", - "enum": [ - "new", - "returning" - ], - "required": false - }, - "customer_type": { - "description": "Limit result set to orders that have the specified customer_type", - "type": "string", - "enum": [ - "new", - "returning" - ], - "required": false - }, - "refunds": { - "description": "Limit result set to specific types of refunds.", - "type": "string", - "default": "", - "enum": [ - "", - "all", - "partial", - "full", - "none" - ], - "required": false - }, - "attribute_is": { - "description": "Limit result set to orders that include products with the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - }, - "attribute_is_not": { - "description": "Limit result set to orders that don't include products with the specified attributes.", - "type": "array", - "items": { - "type": "array" - }, - "default": [], - "required": false - }, - "segmentby": { - "description": "Segment the response by additional constraint.", - "type": "string", - "enum": [ - "product", - "category", - "variation", - "coupon", - "customer_type" - ], - "required": false - }, - "fields": { - "description": "Limit stats fields to the specified items.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders/stats" - } - ] - } - }, - "/wc-analytics/reports/categories": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "category_id", - "enum": [ - "category_id", - "items_sold", - "net_revenue", - "orders_count", - "products_count", - "category" - ], - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "status_is": { - "description": "Limit result set to items that have the specified order status.", - "type": "array", - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - }, - "required": false - }, - "status_is_not": { - "description": "Limit result set to items that don't have the specified order status.", - "type": "array", - "items": { - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "type": "string" - }, - "required": false - }, - "categories": { - "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "extended_info": { - "description": "Add additional piece of info about each category to the report.", - "type": "boolean", - "default": false, - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/categories" - } - ] - } - }, - "/wc-analytics/reports/taxes": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "tax_rate_id", - "enum": [ - "name", - "tax_rate_id", - "tax_code", - "rate", - "order_tax", - "total_tax", - "shipping_tax", - "orders_count" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "taxes": { - "description": "Limit result set to items assigned one or more tax rates.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes" - } - ] - } - }, - "/wc-analytics/reports/taxes/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "items_sold", - "total_sales", - "orders_count", - "products_count" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "taxes": { - "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "segmentby": { - "description": "Segment the response by additional constraint.", - "type": "string", - "enum": [ - "tax_rate_id" - ], - "required": false - }, - "fields": { - "description": "Limit stats fields to the specified items.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes/stats" - } - ] - } - }, - "/wc-analytics/reports/coupons": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "coupon_id", - "enum": [ - "coupon_id", - "code", - "amount", - "orders_count" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "coupons": { - "description": "Limit result set to coupons assigned specific coupon IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "extended_info": { - "description": "Add additional piece of info about each coupon to the report.", - "type": "boolean", - "default": false, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons" - } - ] - } - }, - "/wc-analytics/reports/coupons/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "amount", - "coupons_count", - "orders_count" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "coupons": { - "description": "Limit result set to coupons assigned specific coupon IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "segmentby": { - "description": "Segment the response by additional constraint.", - "type": "string", - "enum": [ - "product", - "variation", - "category", - "coupon" - ], - "required": false - }, - "fields": { - "description": "Limit stats fields to the specified items.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons/stats" - } - ] - } - }, - "/wc-analytics/reports/stock": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "stock_status", - "enum": [ - "stock_status", - "stock_quantity", - "date", - "id", - "include", - "title", - "sku" - ], - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "type": { - "description": "Limit result set to items assigned a stock report type.", - "type": "string", - "default": "all", - "enum": [ - "all", - "lowstock", - "instock", - "outofstock", - "onbackorder" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock" - } - ] - } - }, - "/wc-analytics/reports/stock/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock/stats" - } - ] - } - }, - "/wc-analytics/reports/downloads": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "product" - ], - "required": false - }, - "match": { - "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.", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "product_includes": { - "description": "Limit result set to items that have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "product_excludes": { - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order_includes": { - "description": "Limit result set to items that have the specified order IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "order_excludes": { - "description": "Limit result set to items that don't have the specified order IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "customer_includes": { - "description": "Limit response to objects that have the specified user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "customer_excludes": { - "description": "Limit response to objects that don't have the specified user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "ip_address_includes": { - "description": "Limit response to objects that have a specified IP address.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "ip_address_excludes": { - "description": "Limit response to objects that don't have a specified IP address.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads" - } - ] - } - }, - "/wc-analytics/reports/downloads/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "download_count" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "interval": { - "description": "Time interval to use for buckets in the returned data.", - "type": "string", - "default": "week", - "enum": [ - "hour", - "day", - "week", - "month", - "quarter", - "year" - ], - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "product_includes": { - "description": "Limit result set to items that have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "product_excludes": { - "description": "Limit result set to items that don't have the specified product(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order_includes": { - "description": "Limit result set to items that have the specified order IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "order_excludes": { - "description": "Limit result set to items that don't have the specified order IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "customer_includes": { - "description": "Limit response to objects that have the specified customer IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "customer_excludes": { - "description": "Limit response to objects that don't have the specified customer IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "ip_address_includes": { - "description": "Limit response to objects that have a specified IP address.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "ip_address_excludes": { - "description": "Limit response to objects that don't have a specified IP address.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "fields": { - "description": "Limit stats fields to the specified items.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads/stats" - } - ] - } - }, - "/wc-analytics/reports/customers": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date_registered", - "enum": [ - "username", - "name", - "country", - "city", - "state", - "postcode", - "date_registered", - "date_last_active", - "orders_count", - "total_spend", - "avg_order_value" - ], - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - }, - "registered_before": { - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "registered_after": { - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "search": { - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "type": "string", - "required": false - }, - "searchby": { - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "type": "string", - "default": "name", - "enum": [ - "name", - "username", - "email", - "all" - ], - "required": false - }, - "name_includes": { - "description": "Limit response to objects with specific names.", - "type": "string", - "required": false - }, - "name_excludes": { - "description": "Limit response to objects excluding specific names.", - "type": "string", - "required": false - }, - "username_includes": { - "description": "Limit response to objects with specific usernames.", - "type": "string", - "required": false - }, - "username_excludes": { - "description": "Limit response to objects excluding specific usernames.", - "type": "string", - "required": false - }, - "email_includes": { - "description": "Limit response to objects including emails.", - "type": "string", - "required": false - }, - "email_excludes": { - "description": "Limit response to objects excluding emails.", - "type": "string", - "required": false - }, - "country_includes": { - "description": "Limit response to objects with specific countries.", - "type": "string", - "required": false - }, - "country_excludes": { - "description": "Limit response to objects excluding specific countries.", - "type": "string", - "required": false - }, - "last_active_before": { - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_after": { - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "registered_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "orders_count_min": { - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_max": { - "description": "Limit response to objects with an order count less than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_between": { - "description": "Limit response to objects with an order count between two given integers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "total_spend_min": { - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_max": { - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_between": { - "description": "Limit response to objects with a total order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "avg_order_value_min": { - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "avg_order_value_max": { - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "type": "number", - "required": false - }, - "avg_order_value_between": { - "description": "Limit response to objects with an average order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "last_order_before": { - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_order_after": { - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "customers": { - "description": "Limit result to items with specified customer IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "users": { - "description": "Limit result to items with specified user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "filter_empty": { - "description": "Filter out results where any of the passed fields are empty", - "type": "array", - "items": { - "type": "string", - "enum": [ - "email", - "name", - "country", - "city", - "state", - "postcode" - ] - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers" - } - ] - } - }, - "/wc-analytics/reports/customers/stats": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "registered_before": { - "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "registered_after": { - "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "match": { - "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", - "type": "string", - "default": "all", - "enum": [ - "all", - "any" - ], - "required": false - }, - "search": { - "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", - "type": "string", - "required": false - }, - "searchby": { - "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", - "type": "string", - "default": "name", - "enum": [ - "name", - "username", - "email", - "all" - ], - "required": false - }, - "name_includes": { - "description": "Limit response to objects with specific names.", - "type": "string", - "required": false - }, - "name_excludes": { - "description": "Limit response to objects excluding specific names.", - "type": "string", - "required": false - }, - "username_includes": { - "description": "Limit response to objects with specific usernames.", - "type": "string", - "required": false - }, - "username_excludes": { - "description": "Limit response to objects excluding specific usernames.", - "type": "string", - "required": false - }, - "email_includes": { - "description": "Limit response to objects including emails.", - "type": "string", - "required": false - }, - "email_excludes": { - "description": "Limit response to objects excluding emails.", - "type": "string", - "required": false - }, - "country_includes": { - "description": "Limit response to objects with specific countries.", - "type": "string", - "required": false - }, - "country_excludes": { - "description": "Limit response to objects excluding specific countries.", - "type": "string", - "required": false - }, - "last_active_before": { - "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_after": { - "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_active_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "registered_between": { - "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "orders_count_min": { - "description": "Limit response to objects with an order count greater than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_max": { - "description": "Limit response to objects with an order count less than or equal to given integer.", - "type": "integer", - "required": false - }, - "orders_count_between": { - "description": "Limit response to objects with an order count between two given integers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "total_spend_min": { - "description": "Limit response to objects with a total order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_max": { - "description": "Limit response to objects with a total order spend less than or equal to given number.", - "type": "number", - "required": false - }, - "total_spend_between": { - "description": "Limit response to objects with a total order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "avg_order_value_min": { - "description": "Limit response to objects with an average order spend greater than or equal to given number.", - "type": "number", - "required": false - }, - "avg_order_value_max": { - "description": "Limit response to objects with an average order spend less than or equal to a given number.", - "type": "number", - "required": false - }, - "avg_order_value_between": { - "description": "Limit response to objects with an average order spend between two given numbers.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "last_order_before": { - "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "last_order_after": { - "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", - "type": "string", - "format": "date-time", - "required": false - }, - "customers": { - "description": "Limit result to items with specified customer IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "fields": { - "description": "Limit stats fields to the specified items.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "force_cache_refresh": { - "description": "Force retrieval of fresh data instead of from the cache.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers/stats" - } - ] - } - }, - "/wc-analytics/reports/performance-indicators": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "stats": { - "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.", - "type": "array", - "items": { - "type": "string", - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - }, - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ], - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators" - } - ] - } - }, - "/wc-analytics/reports/performance-indicators/allowed": { - "namespace": "wc-analytics", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "stats": { - "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.", - "type": "array", - "items": { - "type": "string", - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ] - }, - "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", - "taxes/order_tax", - "taxes/shipping_tax", - "downloads/download_count" - ], - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators/allowed" - } - ] - } - }, - "/wc-analytics/admin/notes": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "note_id", - "date", - "type", - "title", - "status" - ], - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "type": { - "description": "Type of note.", - "type": "array", - "items": { - "enum": [ - "error", - "warning", - "update", - "info", - "marketing", - "survey", - "email" - ], - "type": "string" - }, - "required": false - }, - "status": { - "description": "Status of note.", - "type": "array", - "items": { - "enum": [ - "pending", - "actioned", - "unactioned", - "snoozed", - "sent" - ], - "type": "string" - }, - "required": false - }, - "source": { - "description": "Source of note.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "note_id", - "date", - "type", - "title", - "status" - ], - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "type": { - "description": "Type of note.", - "type": "array", - "items": { - "enum": [ - "error", - "warning", - "update", - "info", - "marketing", - "survey", - "email" - ], - "type": "string" - }, - "required": false - }, - "status": { - "description": "Status of note.", - "type": "array", - "items": { - "enum": [ - "pending", - "actioned", - "unactioned", - "snoozed", - "sent" - ], - "type": "string" - }, - "required": false - }, - "source": { - "description": "Source of note.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes" - } - ] - } - }, - "/wc-analytics/admin/notes/(?P\u003Cid\u003E[\\d-]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-analytics/admin/notes/delete/(?P\u003Cid\u003E[\\d-]+)": { - "namespace": "wc-analytics", - "methods": [ - "DELETE", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "DELETE" - ], - "args": [] - }, - { - "methods": [ - "DELETE" - ], - "args": [] - } - ] - }, - "/wc-analytics/admin/notes/delete/all": { - "namespace": "wc-analytics", - "methods": [ - "DELETE", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "DELETE" - ], - "args": { - "status": { - "description": "Status of note.", - "type": "array", - "items": { - "enum": [ - "pending", - "actioned", - "unactioned", - "snoozed", - "sent" - ], - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "status": { - "description": "Status of note.", - "type": "array", - "items": { - "enum": [ - "pending", - "actioned", - "unactioned", - "snoozed", - "sent" - ], - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/delete/all" - } - ] - } - }, - "/wc-analytics/admin/notes/tracker/(?P\u003Cnote_id\u003E[\\d-]+)/user/(?P\u003Cuser_id\u003E[\\d-]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/wc-analytics/admin/notes/update": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/update" - } - ] - } - }, - "/wc-analytics/admin/notes/experimental-activate-promo/(?P\u003Cpromo_note_name\u003E[\\w-]+)": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ] - }, - "/wc-analytics/admin/notes/(?P\u003Cnote_id\u003E[\\d-]+)/action/(?P\u003Caction_id\u003E[\\d-]+)": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "note_id": { - "description": "Unique ID for the Note.", - "type": "integer", - "required": false - }, - "action_id": { - "description": "Unique ID for the Note Action.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "note_id": { - "description": "Unique ID for the Note.", - "type": "integer", - "required": false - }, - "action_id": { - "description": "Unique ID for the Note Action.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-analytics/coupons": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to coupons with codes matching a given string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "code": { - "description": "Limit result set to resources with a specific code.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": true - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "default": "fixed_cart", - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "default": false, - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "default": false, - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "default": false, - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to coupons with codes matching a given string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "code": { - "description": "Limit result set to resources with a specific code.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": true - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "default": "fixed_cart", - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "default": false, - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "default": false, - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "default": false, - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons" - } - ] - } - }, - "/wc-analytics/coupons/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc-analytics/coupons/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons/batch" - } - ] - } - }, - "/wc-analytics/data": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data" - } - ] - } - }, - "/wc-analytics/data/countries/locales": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries/locales" - } - ] - } - }, - "/wc-analytics/data/countries": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries" - } - ] - } - }, - "/wc-analytics/data/countries/(?P\u003Clocation\u003E[\\w-]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "location": { - "description": "ISO3166 alpha-2 country code.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "location": { - "description": "ISO3166 alpha-2 country code.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc-analytics/data/download-ips": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/download-ips" - } - ] - } - }, - "/wc-analytics/orders": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "status": { - "default": [ - "any" - ], - "description": "Limit result set to orders which have specific statuses.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ] - }, - "required": false - }, - "customer": { - "description": "Limit result set to orders assigned a specific customer.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to orders assigned a specific product.", - "type": "integer", - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - }, - "order_item_display_meta": { - "default": false, - "description": "Only show meta which is meant to be displayed for an order.", - "type": "boolean", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "number": { - "description": "Limit result set to orders matching part of an order number.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "default": "pending", - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "default": "EUR", - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "default": 0, - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "default": false, - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "default": false, - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "status": { - "default": [ - "any" - ], - "description": "Limit result set to orders which have specific statuses.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "any", - "trash", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ] - }, - "required": false - }, - "customer": { - "description": "Limit result set to orders assigned a specific customer.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to orders assigned a specific product.", - "type": "integer", - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - }, - "order_item_display_meta": { - "default": false, - "description": "Only show meta which is meant to be displayed for an order.", - "type": "boolean", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "number": { - "description": "Limit result set to orders matching part of an order number.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "default": "pending", - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "default": "EUR", - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "default": 0, - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "default": false, - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "default": false, - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders" - } - ] - } - }, - "/wc-analytics/orders/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc-analytics/orders/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders/batch" - } - ] - } - }, - "/wc-analytics/products": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name or SKU.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order", - "price", - "popularity", - "rating" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "search_sku": { - "description": "Limit results to those with a SKU that partially matches a string.", - "type": "string", - "required": false - }, - "low_in_stock": { - "description": "Limit result set to products that are low or out of stock. (Deprecated)", - "type": "boolean", - "default": false, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "default": "simple", - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "default": false, - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "default": "visible", - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "default": false, - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "default": true, - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name or SKU.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order", - "price", - "popularity", - "rating" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "search_sku": { - "description": "Limit results to those with a SKU that partially matches a string.", - "type": "string", - "required": false - }, - "low_in_stock": { - "description": "Limit result set to products that are low or out of stock. (Deprecated)", - "type": "boolean", - "default": false, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "default": "simple", - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "default": false, - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "default": "visible", - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "default": false, - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "default": true, - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products" - } - ] - } - }, - "/wc-analytics/products/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/batch" - } - ] - } - }, - "/wc-analytics/products/suggested-products": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "in_stock": { - "description": "Limit result set to products in stock or out of stock.", - "type": "boolean", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "categories": { - "description": "Limit result set to specific product categorie ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "tags": { - "description": "Limit result set to specific product tag ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "limit": { - "description": "Limit result set to specific amount of suggested products.", - "type": "integer", - "default": 5, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "in_stock": { - "description": "Limit result set to products in stock or out of stock.", - "type": "boolean", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "categories": { - "description": "Limit result set to specific product categorie ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "tags": { - "description": "Limit result set to specific product tag ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "limit": { - "description": "Limit result set to specific amount of suggested products.", - "type": "integer", - "default": 5, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/suggested-products" - } - ] - } - }, - "/wc-analytics/products/(?P\u003Cid\u003E[\\d]+)/duplicate": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ] - }, - "/wc-analytics/products/attributes": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "search": { - "description": "Search by similar attribute name.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Name for the resource.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "default": "select", - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "default": "menu_order", - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "default": false, - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "search": { - "description": "Search by similar attribute name.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Name for the resource.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "default": "select", - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "default": "menu_order", - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "default": false, - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes" - } - ] - } - }, - "/wc-analytics/products/attributes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/attributes/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes/batch" - } - ] - } - }, - "/wc-analytics/products/attributes/(?P\u003Cslug\u003E[a-z0-9_\\-]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Slug identifier for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Slug identifier for the resource.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/attributes/(?P\u003Cslug\u003E[a-z0-9_\\-]+)/terms": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - } - } - } - ] - }, - "/wc-analytics/products/categories": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "default": "default", - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "default": "default", - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories" - } - ] - } - }, - "/wc-analytics/products/categories/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/categories/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories/batch" - } - ] - } - }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST", - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/generate": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "POST", - "POST", - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "delete": { - "description": "Deletes unused variations.", - "type": "boolean", - "required": false - }, - "default_values": { - "description": "Default values for generated variations.", - "type": "object", - "properties": { - "type": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ] - }, - "description": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation description.", - "type": "string" - }, - "sku": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock Keeping Unit.", - "type": "string" - }, - "global_unique_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string" - }, - "regular_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation regular price.", - "type": "string" - }, - "sale_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation sale price.", - "type": "string" - }, - "date_on_sale_from": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_from_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ] - }, - "virtual": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is virtual.", - "type": "boolean" - }, - "downloadable": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is downloadable.", - "type": "boolean" - }, - "downloads": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer" - }, - "download_expiry": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of days until access to downloadable files expires.", - "type": "integer" - }, - "tax_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ] - }, - "tax_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax class.", - "type": "string" - }, - "manage_stock": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock management at variation level.", - "type": "boolean" - }, - "stock_quantity": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock quantity.", - "type": "integer" - }, - "stock_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ] - }, - "backorders": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ] - }, - "low_stock_amount": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ] - }, - "weight": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation weight (kg).", - "type": "string" - }, - "dimensions": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Shipping class slug.", - "type": "string" - }, - "image": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "menu_order": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Menu order, used to custom sort products.", - "type": "integer" - }, - "meta_data": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - }, - "name": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent name.", - "type": "string" - }, - "parent_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent ID.", - "type": "integer" - } - }, - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "delete": { - "description": "Deletes unused variations.", - "type": "boolean", - "required": false - }, - "default_values": { - "description": "Default values for generated variations.", - "type": "object", - "properties": { - "type": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ] - }, - "description": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation description.", - "type": "string" - }, - "sku": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock Keeping Unit.", - "type": "string" - }, - "global_unique_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string" - }, - "regular_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation regular price.", - "type": "string" - }, - "sale_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation sale price.", - "type": "string" - }, - "date_on_sale_from": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_from_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ] - }, - "virtual": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is virtual.", - "type": "boolean" - }, - "downloadable": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is downloadable.", - "type": "boolean" - }, - "downloads": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer" - }, - "download_expiry": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of days until access to downloadable files expires.", - "type": "integer" - }, - "tax_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ] - }, - "tax_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax class.", - "type": "string" - }, - "manage_stock": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock management at variation level.", - "type": "boolean" - }, - "stock_quantity": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock quantity.", - "type": "integer" - }, - "stock_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ] - }, - "backorders": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ] - }, - "low_stock_amount": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ] - }, - "weight": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation weight (kg).", - "type": "string" - }, - "dimensions": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Shipping class slug.", - "type": "string" - }, - "image": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "menu_order": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Menu order, used to custom sort products.", - "type": "integer" - }, - "meta_data": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - }, - "name": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent name.", - "type": "string" - }, - "parent_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent ID.", - "type": "integer" - } - }, - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "delete": { - "description": "Deletes unused variations.", - "type": "boolean", - "required": false - }, - "default_values": { - "description": "Default values for generated variations.", - "type": "object", - "properties": { - "type": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ] - }, - "description": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation description.", - "type": "string" - }, - "sku": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock Keeping Unit.", - "type": "string" - }, - "global_unique_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string" - }, - "regular_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation regular price.", - "type": "string" - }, - "sale_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation sale price.", - "type": "string" - }, - "date_on_sale_from": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_from_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ] - }, - "virtual": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is virtual.", - "type": "boolean" - }, - "downloadable": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is downloadable.", - "type": "boolean" - }, - "downloads": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer" - }, - "download_expiry": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of days until access to downloadable files expires.", - "type": "integer" - }, - "tax_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ] - }, - "tax_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax class.", - "type": "string" - }, - "manage_stock": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock management at variation level.", - "type": "boolean" - }, - "stock_quantity": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock quantity.", - "type": "integer" - }, - "stock_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ] - }, - "backorders": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ] - }, - "low_stock_amount": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ] - }, - "weight": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation weight (kg).", - "type": "string" - }, - "dimensions": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Shipping class slug.", - "type": "string" - }, - "image": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "menu_order": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Menu order, used to custom sort products.", - "type": "integer" - }, - "meta_data": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - }, - "name": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent name.", - "type": "string" - }, - "parent_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent ID.", - "type": "integer" - } - }, - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "delete": { - "description": "Deletes unused variations.", - "type": "boolean", - "required": false - }, - "default_values": { - "description": "Default values for generated variations.", - "type": "object", - "properties": { - "type": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ] - }, - "description": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation description.", - "type": "string" - }, - "sku": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock Keeping Unit.", - "type": "string" - }, - "global_unique_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string" - }, - "regular_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation regular price.", - "type": "string" - }, - "sale_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation sale price.", - "type": "string" - }, - "date_on_sale_from": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_from_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ] - }, - "virtual": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is virtual.", - "type": "boolean" - }, - "downloadable": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is downloadable.", - "type": "boolean" - }, - "downloads": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer" - }, - "download_expiry": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of days until access to downloadable files expires.", - "type": "integer" - }, - "tax_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ] - }, - "tax_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax class.", - "type": "string" - }, - "manage_stock": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock management at variation level.", - "type": "boolean" - }, - "stock_quantity": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock quantity.", - "type": "integer" - }, - "stock_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ] - }, - "backorders": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ] - }, - "low_stock_amount": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ] - }, - "weight": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation weight (kg).", - "type": "string" - }, - "dimensions": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Shipping class slug.", - "type": "string" - }, - "image": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "menu_order": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Menu order, used to custom sort products.", - "type": "integer" - }, - "meta_data": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - }, - "name": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent name.", - "type": "string" - }, - "parent_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Product parent ID.", - "type": "integer" - } - }, - "required": false - }, - "type": { - "default": "variation", - "description": "Product type.", - "type": "string", - "enum": [ - "variation" - ], - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "name": { - "description": "Product parent name.", - "type": "string", - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-analytics/variations": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET", - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Search by similar product name, SKU, or attribute value.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/variations" - } - ] - } - }, - "/wc-analytics/products/reviews": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to reviews published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date_gmt", - "enum": [ - "date", - "date_gmt", - "id", - "include", - "product" - ], - "required": false - }, - "reviewer": { - "description": "Limit result set to reviews assigned to specific user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "reviewer_exclude": { - "description": "Ensure result set excludes reviews assigned to specific user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "reviewer_email": { - "default": null, - "description": "Limit result set to that from a specific author email.", - "format": "email", - "type": "string", - "required": false - }, - "product": { - "default": [], - "description": "Limit result set to reviews assigned to specific product IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "status": { - "default": "approved", - "description": "Limit result set to reviews assigned a specific status.", - "type": "string", - "enum": [ - "all", - "hold", - "approved", - "spam", - "trash" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the product.", - "type": "integer", - "required": true - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "default": "approved", - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "type": "string", - "description": "Name of the reviewer.", - "required": true - }, - "reviewer_email": { - "type": "string", - "description": "Email of the reviewer.", - "required": true - }, - "review": { - "type": "string", - "description": "Review content.", - "required": true - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to reviews published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date_gmt", - "enum": [ - "date", - "date_gmt", - "id", - "include", - "product" - ], - "required": false - }, - "reviewer": { - "description": "Limit result set to reviews assigned to specific user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "reviewer_exclude": { - "description": "Ensure result set excludes reviews assigned to specific user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "reviewer_email": { - "default": null, - "description": "Limit result set to that from a specific author email.", - "format": "email", - "type": "string", - "required": false - }, - "product": { - "default": [], - "description": "Limit result set to reviews assigned to specific product IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "status": { - "default": "approved", - "description": "Limit result set to reviews assigned a specific status.", - "type": "string", - "enum": [ - "all", - "hold", - "approved", - "spam", - "trash" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the product.", - "type": "integer", - "required": true - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "default": "approved", - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "type": "string", - "description": "Name of the reviewer.", - "required": true - }, - "reviewer_email": { - "type": "string", - "description": "Email of the reviewer.", - "required": true - }, - "review": { - "type": "string", - "description": "Review content.", - "required": true - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews" - } - ] - } - }, - "/wc-analytics/products/reviews/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "product_id": { - "description": "Unique identifier for the product that the review belongs to.", - "type": "integer", - "required": false - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "reviewer_email": { - "description": "Reviewer email.", - "type": "string", - "format": "email", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "product_id": { - "description": "Unique identifier for the product that the review belongs to.", - "type": "integer", - "required": false - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "reviewer_email": { - "description": "Reviewer email.", - "type": "string", - "format": "email", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc-analytics/products/reviews/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the product that the review belongs to.", - "type": "integer", - "required": false - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "reviewer_email": { - "description": "Reviewer email.", - "type": "string", - "format": "email", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the product that the review belongs to.", - "type": "integer", - "required": false - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "reviewer_email": { - "description": "Reviewer email.", - "type": "string", - "format": "email", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews/batch" - } - ] - } - }, - "/wc-analytics/products/low-in-stock": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/low-in-stock" - } - ] - } - }, - "/wc-analytics/products/count-low-in-stock": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/count-low-in-stock" - } - ] - } - }, - "/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - } - ] - }, - "/wc-analytics/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - } - ] - }, - "/wc-analytics/taxes": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "order", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "order", - "priority" - ], - "type": "string", - "required": false - }, - "class": { - "description": "Sort by tax class.", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "type": "string", - "required": false - }, - "search": { - "description": "Search by similar tax code.", - "type": "string", - "required": false - }, - "include": { - "description": "Limit result set to items that have the specified rate ID(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "default": 1, - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "default": false, - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "default": true, - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "default": "standard", - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "order", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "order", - "priority" - ], - "type": "string", - "required": false - }, - "class": { - "description": "Sort by tax class.", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "type": "string", - "required": false - }, - "search": { - "description": "Search by similar tax code.", - "type": "string", - "required": false - }, - "include": { - "description": "Limit result set to items that have the specified rate ID(s) assigned.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "default": 1, - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "default": false, - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "default": true, - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "default": "standard", - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes" - } - ] - } - }, - "/wc-analytics/taxes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc-analytics", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc-analytics/taxes/batch": { - "namespace": "wc-analytics", - "methods": [ - "POST", - "PUT", - "PATCH", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes/batch" - } - ] - } - }, - "/wc/store": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc/store", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store" - } - ] - } - }, - "/wc/store/batch": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "validation": { - "type": "string", - "enum": [ - "require-all-validate", - "normal" - ], - "default": "normal", - "required": false - }, - "requests": { - "type": "array", "maxItems": 25, - "items": { - "type": "object", - "properties": { - "method": { - "type": "string", - "enum": [ - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "default": "POST" - }, - "path": { - "type": "string", - "required": true - }, - "body": { - "type": "object", - "properties": [], - "additionalProperties": true - }, - "headers": { - "type": "object", - "properties": [], - "additionalProperties": { - "type": [ - "string", - "array" - ], - "items": { - "type": "string" - } - } - } - } - }, - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/batch" - } - ] - } - }, - "/wc/store/cart": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart" - } - ] - } - }, - "/wc/store/cart/add-item": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "The basket item product or variation ID.", - "type": "integer", - "required": false + "required": true, + "type": "array" }, - "quantity": { - "description": "Quantity of this item to add to the basket.", - "type": "integer", - "required": false - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/add-item" - } - ] - } - }, - "/wc/store/cart/apply-coupon": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/apply-coupon" - } - ] - } - }, - "/wc/store/cart/coupons": { - "namespace": "wc/store", - "methods": [ - "GET", - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "The coupon's unique code.", - "type": "string", - "required": false - }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/coupons" - } - ] - } - }, - "/wc/store/cart/coupons/(?P\u003Ccode\u003E[\\w-]+)": { - "namespace": "wc/store", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/store/cart/extensions": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "namespace": { - "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", - "type": "string", - "required": false - }, - "data": { - "description": "Additional data to pass to the extension", - "type": "object", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/extensions" - } - ] - } - }, - "/wc/store/cart/items": { - "namespace": "wc/store", - "methods": [ - "GET", - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "extensions": { - "type": "object", - "properties": [], - "default": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/items" - } - ] - } - }, - "/wc/store/cart/items/(?P\u003Ckey\u003E[\\w-]{32})": { - "namespace": "wc/store", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "required": false - }, - "extensions": { - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/store/cart/remove-coupon": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-coupon" - } - ] - } - }, - "/wc/store/cart/remove-item": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier (key) for the basket item.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-item" - } - ] - } - }, - "/wc/store/cart/select-shipping-rate": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "package_id": { - "description": "The ID of the package being shipped. Leave blank to apply to all packages.", - "type": [ - "integer", - "string", - "null" - ], - "required": false - }, - "rate_id": { - "description": "The chosen rate ID for the package.", - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/select-shipping-rate" - } - ] - } - }, - "/wc/store/cart/update-item": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier (key) for the basket item to update.", - "type": "string", - "required": false - }, - "quantity": { - "description": "New quantity of the item in the basket.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-item" - } - ] - } - }, - "/wc/store/cart/update-customer": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "billing_address": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "email": { - "description": "Email", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-customer" - } - ] - } - }, - "/wc/store/checkout": { - "namespace": "wc/store", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "payment_data": { - "description": "Data to pass through to the payment method when processing payment.", - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": [ - "string", - "boolean" - ] - } - } - }, - "required": false - }, - "customer_password": { - "description": "Customer password for new accounts, if applicable.", - "type": "string", - "required": false - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "required": false - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "email": { - "description": "Email", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "enum": [ - "bacs", - "cheque", - "cod" - ], - "required": false - }, - "create_account": { - "description": "Whether to create a new user account as part of order processing.", - "type": "boolean", - "required": false - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": [ - "object", - "null" - ], - "context": [ - "view", - "edit" - ], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": [ - "string", - "null" - ], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": [ - "string", - "null" - ], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": [ - "string", - "null" - ], - "context": [] - } - } - } - }, - "default": { - "woocommerce/order-attribution": [] - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/checkout" - } - ] - } - }, - "/wc/store/checkout/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "payment_data": { - "description": "Data to pass through to the payment method when processing payment.", - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": [ - "string", - "boolean" - ] - } - } - }, - "required": false - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "required": false - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "email": { - "description": "Email", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "enum": [ - "bacs", - "cheque", - "cod" - ], - "required": false - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": [ - "object", - "null" - ], - "context": [ - "view", - "edit" - ], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": [ - "string", - "null" - ], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": [ - "string", - "null" - ], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": [ - "string", - "null" - ], - "context": [] - } - } - } - }, - "default": { - "woocommerce/order-attribution": [] - }, - "required": false - } - } - } - ] - }, - "/wc/store/order/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/products/attributes": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/attributes" - } - ] - } - }, - "/wc/store/products/attributes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Sort ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort by term property.", - "type": "string", - "default": "name", - "enum": [ - "name", - "slug", - "count", - "menu_order", - "name_num", - "id" - ], - "required": false - }, - "hide_empty": { - "description": "If true, empty terms will not be returned.", - "type": "boolean", - "default": true, - "required": false - } - } - } - ] - }, - "/wc/store/products/categories": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Sort ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort by term property.", - "type": "string", - "default": "name", - "enum": [ - "name", - "slug", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "If true, empty terms will not be returned.", - "type": "boolean", - "default": true, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/categories" - } - ] - } - }, - "/wc/store/products/categories/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/products/collection-data": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "default": 10, - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "slug": { - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "date_column": { - "description": "When limiting response using after/before, which date column to compare against.", - "type": "string", - "default": "date", - "enum": [ - "date", - "date_gmt", - "modified", - "modified_gmt" - ], - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable", - "variation" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "category_operator": { - "description": "Operator to compare product category terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "tag_operator": { - "description": "Operator to compare product tags.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - }, - "default": [], - "required": false - }, - "attributes": { - "description": "Limit result set to products with selected global attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ] - } - } - }, - "default": [], - "required": false - }, - "attribute_relation": { - "description": "The logical relationship between attributes when filtering across several at once.", - "type": "string", - "enum": [ - "in", - "and" - ], - "default": "and", - "required": false - }, - "catalog_visibility": { - "description": "Determines if hidden or visible catalogue products are shown.", - "type": "string", - "enum": [ - "any", - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "rating": { - "description": "Limit result set to products with a certain average rating.", - "type": "array", - "items": { - "type": "integer", - "enum": [1, 2, 3, 4, 5] - }, - "default": [], - "required": false - }, - "calculate_price_range": { - "description": "If true, calculates the minimum and maximum product prices for the collection.", - "type": "boolean", - "default": false, - "required": false - }, - "calculate_stock_status_counts": { - "description": "If true, calculates stock counts for products in the collection.", - "type": "boolean", - "default": false, - "required": false - }, - "calculate_attribute_counts": { - "description": "If requested, calculates attribute term counts for products in the collection.", - "type": "array", - "items": { - "type": "object", - "properties": { - "taxonomy": { - "description": "Taxonomy name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "query_type": { - "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "type": "string", - "enum": [ - "and", - "or" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "default": [], - "required": false - }, - "calculate_rating_counts": { - "description": "If true, calculates rating counts for products in the collection.", - "type": "boolean", - "default": false, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/collection-data" - } - ] - } - }, - "/wc/store/products/reviews": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "default": 10, - "minimum": 0, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "date_gmt", - "id", - "rating", - "product" - ], - "required": false - }, - "category_id": { - "description": "Limit result set to reviews from specific category IDs.", - "type": "string", - "required": false - }, - "product_id": { - "description": "Limit result set to reviews from specific product IDs.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/reviews" - } - ] - } - }, - "/wc/store/products/tags": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Sort ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort by term property.", - "type": "string", - "default": "name", - "enum": [ - "name", - "slug", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "If true, empty terms will not be returned.", - "type": "boolean", - "default": true, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/tags" - } - ] - } - }, - "/wc/store/products": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "default": 10, - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "slug": { - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "date_column": { - "description": "When limiting response using after/before, which date column to compare against.", - "type": "string", - "default": "date", - "enum": [ - "date", - "date_gmt", - "modified", - "modified_gmt" - ], - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable", - "variation" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "category_operator": { - "description": "Operator to compare product category terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "tag_operator": { - "description": "Operator to compare product tags.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - }, - "default": [], - "required": false - }, - "attributes": { - "description": "Limit result set to products with selected global attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ] - } - } - }, - "default": [], - "required": false - }, - "attribute_relation": { - "description": "The logical relationship between attributes when filtering across several at once.", - "type": "string", - "enum": [ - "in", - "and" - ], - "default": "and", - "required": false - }, - "catalog_visibility": { - "description": "Determines if hidden or visible catalogue products are shown.", - "type": "string", - "enum": [ - "any", - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "rating": { - "description": "Limit result set to products with a certain average rating.", - "type": "array", - "items": { - "type": "integer", - "enum": [1, 2, 3, 4, 5] - }, - "default": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products" - } - ] - } - }, - "/wc/store/products/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/products/(?P\u003Cslug\u003E[\\S]+)": { - "namespace": "wc/store", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Slug of the resource.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/v1": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc/store/v1", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1" - } - ] - } - }, - "/wc/store/v1/batch": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { "validation": { - "type": "string", - "enum": [ - "require-all-validate", - "normal" - ], "default": "normal", - "required": false - }, - "requests": { - "type": "array", - "maxItems": 25, - "items": { - "type": "object", - "properties": { - "method": { - "type": "string", - "enum": [ - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "default": "POST" - }, - "path": { - "type": "string", - "required": true - }, - "body": { - "type": "object", - "properties": [], - "additionalProperties": true - }, - "headers": { - "type": "object", - "properties": [], - "additionalProperties": { - "type": [ - "string", - "array" - ], - "items": { - "type": "string" - } - } - } - } - }, - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/batch" - } - ] - } - }, - "/wc/store/v1/cart": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", "enum": [ - "view", - "edit" + "normal", + "require-all-validate" ], - "default": "view", - "required": false + "required": false, + "type": "string" } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart" - } - ] - } - }, - "/wc/store/v1/cart/add-item": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true }, - "args": { - "id": { - "description": "The basket item product or variation ID.", - "type": "integer", - "required": false - }, - "quantity": { - "description": "Quantity of this item to add to the basket.", - "type": "integer", - "required": false - }, - "variation": { - "description": "Chosen attributes (for variations).", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Variation attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Variation attribute value.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/add-item" - } - ] - } - }, - "/wc/store/v1/cart/apply-coupon": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/apply-coupon" - } - ] - } - }, - "/wc/store/v1/cart/coupons": { - "namespace": "wc/store/v1", - "methods": [ - "GET", - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "The coupon's unique code.", - "type": "string", - "required": false - }, - "discount_type": { - "description": "The discount type for the coupon (eg percentage or fixed amount)", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/coupons" - } - ] - } - }, - "/wc/store/v1/cart/coupons/(?P\u003Ccode\u003E[\\w-]+)": { - "namespace": "wc/store/v1", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/store/v1/cart/extensions": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "namespace": { - "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", - "type": "string", - "required": false - }, - "data": { - "description": "Additional data to pass to the extension", - "type": "object", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/extensions" - } - ] - } - }, - "/wc/store/v1/cart/items": { - "namespace": "wc/store/v1", - "methods": [ - "GET", - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "extensions": { - "type": "object", - "properties": [], - "default": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/items" - } - ] - } - }, - "/wc/store/v1/cart/items/(?P\u003Ckey\u003E[\\w-]{32})": { - "namespace": "wc/store/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "required": false - }, - "extensions": { - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier for the item within the basket.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/store/v1/cart/remove-coupon": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "code": { - "description": "Unique identifier for the coupon within the basket.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-coupon" - } - ] - } - }, - "/wc/store/v1/cart/remove-item": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier (key) for the basket item.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-item" - } - ] - } - }, - "/wc/store/v1/cart/select-shipping-rate": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "package_id": { - "description": "The ID of the package being shipped. Leave blank to apply to all packages.", - "type": [ - "integer", - "string", - "null" - ], - "required": false - }, - "rate_id": { - "description": "The chosen rate ID for the package.", - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/select-shipping-rate" - } - ] - } - }, - "/wc/store/v1/cart/update-item": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "key": { - "description": "Unique identifier (key) for the basket item to update.", - "type": "string", - "required": false - }, - "quantity": { - "description": "New quantity of the item in the basket.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-item" - } - ] - } - }, - "/wc/store/v1/cart/update-customer": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "billing_address": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "email": { - "description": "Email", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-customer" - } - ] - } - }, - "/wc/store/v1/checkout": { - "namespace": "wc/store/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "payment_data": { - "description": "Data to pass through to the payment method when processing payment.", - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": [ - "string", - "boolean" - ] - } - } - }, - "required": false - }, - "customer_password": { - "description": "Customer password for new accounts, if applicable.", - "type": "string", - "required": false - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "required": false - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "email": { - "description": "Email", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "enum": [ - "bacs", - "cheque", - "cod" - ], - "required": false - }, - "create_account": { - "description": "Whether to create a new user account as part of order processing.", - "type": "boolean", - "required": false - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": [ - "object", - "null" - ], - "context": [ - "view", - "edit" - ], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": [ - "string", - "null" - ], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": [ - "string", - "null" - ], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": [ - "string", - "null" - ], - "context": [] - } - } - } - }, - "default": { - "woocommerce/order-attribution": [] - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/checkout" - } - ] - } - }, - "/wc/store/v1/checkout/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store/v1", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "payment_data": { - "description": "Data to pass through to the payment method when processing payment.", - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": [ - "string", - "boolean" - ] - } - } - }, - "required": false - }, - "customer_note": { - "description": "Note added to the order by the customer during checkout.", - "type": "string", - "required": false - }, - "billing_address": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "email": { - "description": "Email", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": true - }, - "shipping_address": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "last_name": { - "description": "Last name", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "company": { - "description": "Company", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_1": { - "description": "Address", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "address_2": { - "description": "Flat, suite, etc.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "city": { - "description": "City", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "state": { - "description": "State/County code, or name of the state, county, province, or district.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "postcode": { - "description": "Postcode", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "country": { - "description": "Country/Region code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - }, - "phone": { - "description": "Phone", - "type": "string", - "context": [ - "view", - "edit" - ], - "required": true - } - }, - "required": false - }, - "payment_method": { - "description": "The ID of the payment method being used to process the payment.", - "type": "string", - "enum": [ - "bacs", - "cheque", - "cod" - ], - "required": false - }, - "additional_fields": { - "description": "Additional fields to be persisted on the order.", - "type": "object", - "properties": [], - "required": false - }, - "extensions": { - "type": "object", - "properties": { - "woocommerce/order-attribution": { - "description": "Extension data registered by woocommerce/order-attribution", - "type": [ - "object", - "null" - ], - "context": [ - "view", - "edit" - ], - "properties": { - "source_type": { - "description": "Order attribution field: source_type", - "type": [ - "string", - "null" - ], - "context": [] - }, - "referrer": { - "description": "Order attribution field: referrer", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_campaign": { - "description": "Order attribution field: utm_campaign", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source": { - "description": "Order attribution field: utm_source", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_medium": { - "description": "Order attribution field: utm_medium", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_content": { - "description": "Order attribution field: utm_content", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_id": { - "description": "Order attribution field: utm_id", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_term": { - "description": "Order attribution field: utm_term", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_source_platform": { - "description": "Order attribution field: utm_source_platform", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_creative_format": { - "description": "Order attribution field: utm_creative_format", - "type": [ - "string", - "null" - ], - "context": [] - }, - "utm_marketing_tactic": { - "description": "Order attribution field: utm_marketing_tactic", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_entry": { - "description": "Order attribution field: session_entry", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_start_time": { - "description": "Order attribution field: session_start_time", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_pages": { - "description": "Order attribution field: session_pages", - "type": [ - "string", - "null" - ], - "context": [] - }, - "session_count": { - "description": "Order attribution field: session_count", - "type": [ - "string", - "null" - ], - "context": [] - }, - "user_agent": { - "description": "Order attribution field: user_agent", - "type": [ - "string", - "null" - ], - "context": [] - } - } - } - }, - "default": { - "woocommerce/order-attribution": [] - }, - "required": false - } - } - } - ] - }, - "/wc/store/v1/order/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/v1/products/attributes": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/attributes" - } - ] - } - }, - "/wc/store/v1/products/attributes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Sort ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort by term property.", - "type": "string", - "default": "name", - "enum": [ - "name", - "slug", - "count", - "menu_order", - "name_num", - "id" - ], - "required": false - }, - "hide_empty": { - "description": "If true, empty terms will not be returned.", - "type": "boolean", - "default": true, - "required": false - } - } - } - ] - }, - "/wc/store/v1/products/categories": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Sort ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort by term property.", - "type": "string", - "default": "name", - "enum": [ - "name", - "slug", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "If true, empty terms will not be returned.", - "type": "boolean", - "default": true, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/categories" - } - ] - } - }, - "/wc/store/v1/products/categories/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/v1/products/collection-data": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "default": 10, - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "slug": { - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "date_column": { - "description": "When limiting response using after/before, which date column to compare against.", - "type": "string", - "default": "date", - "enum": [ - "date", - "date_gmt", - "modified", - "modified_gmt" - ], - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable", - "variation" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "category_operator": { - "description": "Operator to compare product category terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "tag_operator": { - "description": "Operator to compare product tags.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - }, - "default": [], - "required": false - }, - "attributes": { - "description": "Limit result set to products with selected global attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ] - } - } - }, - "default": [], - "required": false - }, - "attribute_relation": { - "description": "The logical relationship between attributes when filtering across several at once.", - "type": "string", - "enum": [ - "in", - "and" - ], - "default": "and", - "required": false - }, - "catalog_visibility": { - "description": "Determines if hidden or visible catalogue products are shown.", - "type": "string", - "enum": [ - "any", - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "rating": { - "description": "Limit result set to products with a certain average rating.", - "type": "array", - "items": { - "type": "integer", - "enum": [1, 2, 3, 4, 5] - }, - "default": [], - "required": false - }, - "calculate_price_range": { - "description": "If true, calculates the minimum and maximum product prices for the collection.", - "type": "boolean", - "default": false, - "required": false - }, - "calculate_stock_status_counts": { - "description": "If true, calculates stock counts for products in the collection.", - "type": "boolean", - "default": false, - "required": false - }, - "calculate_attribute_counts": { - "description": "If requested, calculates attribute term counts for products in the collection.", - "type": "array", - "items": { - "type": "object", - "properties": { - "taxonomy": { - "description": "Taxonomy name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "query_type": { - "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", - "type": "string", - "enum": [ - "and", - "or" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "default": [], - "required": false - }, - "calculate_rating_counts": { - "description": "If true, calculates rating counts for products in the collection.", - "type": "boolean", - "default": false, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/collection-data" - } - ] - } - }, - "/wc/store/v1/products/reviews": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "default": 10, - "minimum": 0, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "date_gmt", - "id", - "rating", - "product" - ], - "required": false - }, - "category_id": { - "description": "Limit result set to reviews from specific category IDs.", - "type": "string", - "required": false - }, - "product_id": { - "description": "Limit result set to reviews from specific product IDs.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/reviews" - } - ] - } - }, - "/wc/store/v1/products/tags": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Sort ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort by term property.", - "type": "string", - "default": "name", - "enum": [ - "name", - "slug", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "If true, empty terms will not be returned.", - "type": "boolean", - "default": true, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/tags" - } - ] - } - }, - "/wc/store/v1/products": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", - "type": "integer", - "default": 10, - "minimum": 0, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "slug": { - "description": "Limit result set to products with specific slug(s). Use commas to separate.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources created after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources created before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "date_column": { - "description": "When limiting response using after/before, which date column to compare against.", - "type": "string", - "default": "date", - "enum": [ - "date", - "date_gmt", - "modified", - "modified_gmt" - ], - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "modified", - "id", - "include", - "title", - "slug", - "price", - "popularity", - "rating", - "menu_order", - "comment_count" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable", - "variation" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "category_operator": { - "description": "Operator to compare product category terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "tag_operator": { - "description": "Operator to compare product tags.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ], - "default": "in", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", - "type": "string", - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "sanitize_callback": "sanitize_text_field", - "validate_callback": "rest_validate_request_arg" - }, - "default": [], - "required": false - }, - "attributes": { - "description": "Limit result set to products with selected global attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "description": "Attribute taxonomy name.", - "type": "string", - "sanitize_callback": "wc_sanitize_taxonomy_name" - }, - "term_id": { - "description": "List of attribute term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "sanitize_callback": "wp_parse_id_list" - }, - "slug": { - "description": "List of attribute slug(s). If a term ID is provided, this will be ignored.", - "type": "array", - "items": { - "type": "string" - }, - "sanitize_callback": "wp_parse_slug_list" - }, - "operator": { - "description": "Operator to compare product attribute terms.", - "type": "string", - "enum": [ - "in", - "not_in", - "and" - ] - } - } - }, - "default": [], - "required": false - }, - "attribute_relation": { - "description": "The logical relationship between attributes when filtering across several at once.", - "type": "string", - "enum": [ - "in", - "and" - ], - "default": "and", - "required": false - }, - "catalog_visibility": { - "description": "Determines if hidden or visible catalogue products are shown.", - "type": "string", - "enum": [ - "any", - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "rating": { - "description": "Limit result set to products with a certain average rating.", - "type": "array", - "items": { - "type": "integer", - "enum": [1, 2, 3, 4, 5] - }, - "default": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products" - } - ] - } - }, - "/wc/store/v1/products/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/store/v1/products/(?P\u003Cslug\u003E[\\S]+)": { - "namespace": "wc/store/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Slug of the resource.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/private": { - "namespace": "wc/private", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc/private", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private" - } - ] - } - }, - "/wc/private/ai/store-title": { - "namespace": "wc/private", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "business_description": { - "description": "The business description for a given store.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-title" - } - ] - } - }, - "/wc/private/ai/images": { - "namespace": "wc/private", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "business_description": { - "description": "The business description for a given store.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/images" - } - ] - } - }, - "/wc/private/ai/patterns": { - "namespace": "wc/private", - "methods": [ - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "business_description": { - "description": "The business description for a given store.", - "type": "string", - "required": false - }, - "images": { - "description": "The images for a given store.", - "type": "object", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/patterns" - } - ] - } - }, - "/wc/private/ai/product": { - "namespace": "wc/private", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "products_information": { - "description": "Data generated by AI for updating dummy products.", - "type": "object", - "required": false - }, - "last_product": { - "description": "Whether the product being updated is the last one in the loop", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/product" - } - ] - } - }, - "/wc/private/ai/products": { - "namespace": "wc/private", - "methods": [ - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "business_description": { - "description": "The business description for a given store.", - "type": "string", - "required": false - }, - "images": { - "description": "The images for a given store.", - "type": "object", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/products" - } - ] - } - }, - "/wc/private/ai/business-description": { - "namespace": "wc/private", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "business_description": { - "description": "The business description for a given store.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/business-description" - } - ] - } - }, - "/wc/private/ai/store-info": { - "namespace": "wc/private", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-info" - } - ] - } - }, - "/wc/private/patterns": { - "namespace": "wc/private", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/patterns" - } - ] - } - }, - "/wc/v1": { - "namespace": "wc/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc/v1", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1" - } - ] - } - }, - "/wc/v1/coupons": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "filter": { - "type": "object", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false - }, - "code": { - "description": "Limit result set to resources with a specific code.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": true - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "discount_type": { - "default": "fixed_cart", - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "expiry_date": { - "description": "UTC DateTime when the coupon expires.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "default": false, - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "default": false, - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "default": false, - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons" - } - ] - } - }, - "/wc/v1/coupons/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "expiry_date": { - "description": "UTC DateTime when the coupon expires.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v1/coupons/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "expiry_date": { - "description": "UTC DateTime when the coupon expires.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons/batch" - } - ] - } - }, - "/wc/v1/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": { - "namespace": "wc/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "customer_id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v1/customers": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "name", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "include", - "name", - "registered_date" - ], - "type": "string", - "required": false - }, - "email": { - "description": "Limit result set to resources with a specific email.", - "type": "string", - "format": "email", - "required": false - }, - "role": { - "description": "Limit result set to resources with a specific role.", - "type": "string", - "default": "customer", - "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "email": { - "type": "string", - "description": "New user email address.", - "required": true - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "New user username.", - "type": "string", - "required": false - }, - "password": { - "description": "New user password.", - "type": "string", - "required": true - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers" - } - ] - } - }, - "/wc/v1/customers/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "email": { - "description": "The email address for the customer.", - "type": "string", - "format": "email", - "required": false - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "Customer login name.", - "type": "string", - "required": false - }, - "password": { - "description": "Customer password.", - "type": "string", - "required": false - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - }, - "reassign": { - "default": 0, - "type": "integer", - "description": "ID to reassign posts to.", - "required": false - } - } - } - ] - }, - "/wc/v1/customers/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "email": { - "description": "The email address for the customer.", - "type": "string", - "format": "email", - "required": false - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "Customer login name.", - "type": "string", - "required": false - }, - "password": { - "description": "Customer password.", - "type": "string", - "required": false - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers/batch" - } - ] - } - }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "note": { - "type": "string", - "description": "Order note content.", - "required": true - }, - "customer_note": { - "default": false, - "description": "Shows/define if the note is only for reference or for the customer (the user will be notified).", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "filter": { - "type": "object", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to orders assigned a specific status.", - "type": "string", - "enum": [ - "any", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "customer": { - "description": "Limit result set to orders assigned a specific customer.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to orders assigned a specific product.", - "type": "integer", - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "amount": { - "description": "Refund amount.", - "type": "string", - "required": false - }, - "reason": { - "description": "Reason for refund.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v1/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/orders": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "filter": { - "type": "object", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to orders assigned a specific status.", - "type": "string", - "enum": [ - "any", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "customer": { - "description": "Limit result set to orders assigned a specific customer.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to orders assigned a specific product.", - "type": "integer", - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "default": "pending", - "description": "Order status.", - "type": "string", - "enum": [ - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "default": "EUR", - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "default": 0, - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "set_paid": { - "default": false, - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta": { - "description": "Line item meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "Meta label.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders" - } - ] - } - }, - "/wc/v1/orders/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta": { - "description": "Line item meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "Meta label.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v1/orders/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta": { - "description": "Line item meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "Meta label.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders/batch" - } - ] - } - }, - "/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc/v1/products/attributes": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Name for the resource.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "default": "select", - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "default": "menu_order", - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "default": false, - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes" - } - ] - } - }, - "/wc/v1/products/attributes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/products/attributes/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes/batch" - } - ] - } - }, - "/wc/v1/products/categories": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "default": "default", - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "title": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories" - } - ] - } - }, - "/wc/v1/products/categories/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "title": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/products/categories/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "title": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories/batch" - } - ] - } - }, - "/wc/v1/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "review": { - "type": "string", - "description": "Review content.", - "required": true - }, - "date_created": { - "description": "The date the review was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - }, - "name": { - "type": "string", - "description": "Name of the reviewer.", - "required": true - }, - "email": { - "type": "string", - "description": "Email of the reviewer.", - "required": true - } - } - } - ] - }, - "/wc/v1/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the review was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - }, - "name": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "email": { - "description": "Reviewer email.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v1/products/shipping_classes": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes" - } - ] - } - }, - "/wc/v1/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Shipping class name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/products/shipping_classes/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Shipping class name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes/batch" - } - ] - } - }, - "/wc/v1/products/tags": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags" - } - ] - } - }, - "/wc/v1/products/tags/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Tag name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/products/tags/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Tag name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags/batch" - } - ] - } - }, - "/wc/v1/products": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "filter": { - "type": "object", - "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "sku": { - "description": "Limit result set to products with a specific SKU.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "type": { - "default": "simple", - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - }, - "featured": { - "default": false, - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "default": "visible", - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price.", - "type": "string", - "required": false - }, - "date_on_sale_to": { - "description": "End data of sale price.", - "type": "string", - "required": false - }, - "virtual": { - "default": false, - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "download_type": { - "default": "standard", - "description": "Download type, this controls the schema on the front-end.", - "type": "string", - "enum": [ - "standard" - ], - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "default": true, - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", - "type": "boolean", - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "sold_individually": { - "default": false, - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "default": true, - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "variations": { - "description": "List of variations.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Variation ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created": { - "description": "The date the variation was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the variation was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "permalink": { - "description": "Variation URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "price": { - "description": "Current variation price.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "date_on_sale_from": { - "description": "Start date of sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "date_on_sale_to": { - "description": "End data of sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "on_sale": { - "description": "Shows if the variation is on sale.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "purchasable": { - "description": "Shows if the variation can be bought.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "visible": { - "description": "If the variation is visible.", - "type": "boolean", - "context": [ - "view", - "edit" - ] - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "default": null, - "context": [ - "view", - "edit" - ] - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "default": null, - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "default": "taxable", - "enum": [ - "taxable", - "shipping", - "none" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "in_stock": { - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "default": true, - "context": [ - "view", - "edit" - ] - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "default": "no", - "enum": [ - "no", - "notify", - "yes" - ], - "context": [ - "view", - "edit" - ] - }, - "backorders_allowed": { - "description": "Shows if back-orders are allowed.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "backordered": { - "description": "Shows if the variation is on back-order.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "context": [ - "view", - "edit" - ], - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "shipping_class_id": { - "description": "Shipping class ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Variation image data.", - "type": "object", - "context": [ - "view", - "edit" - ], - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products" - } - ] - } - }, - "/wc/v1/products/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price.", - "type": "string", - "required": false - }, - "date_on_sale_to": { - "description": "End data of sale price.", - "type": "string", - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "download_type": { - "description": "Download type, this controls the schema on the front-end.", - "type": "string", - "enum": [ - "standard" - ], - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", - "type": "boolean", - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "variations": { - "description": "List of variations.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Variation ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created": { - "description": "The date the variation was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the variation was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "permalink": { - "description": "Variation URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "price": { - "description": "Current variation price.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "date_on_sale_from": { - "description": "Start date of sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "date_on_sale_to": { - "description": "End data of sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "on_sale": { - "description": "Shows if the variation is on sale.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "purchasable": { - "description": "Shows if the variation can be bought.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "visible": { - "description": "If the variation is visible.", - "type": "boolean", - "context": [ - "view", - "edit" - ] - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "default": null, - "context": [ - "view", - "edit" - ] - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "default": null, - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "default": "taxable", - "enum": [ - "taxable", - "shipping", - "none" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "in_stock": { - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "default": true, - "context": [ - "view", - "edit" - ] - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "default": "no", - "enum": [ - "no", - "notify", - "yes" - ], - "context": [ - "view", - "edit" - ] - }, - "backorders_allowed": { - "description": "Shows if back-orders are allowed.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "backordered": { - "description": "Shows if the variation is on back-order.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "context": [ - "view", - "edit" - ], - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "shipping_class_id": { - "description": "Shipping class ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Variation image data.", - "type": "object", - "context": [ - "view", - "edit" - ], - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc/v1/products/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price.", - "type": "string", - "required": false - }, - "date_on_sale_to": { - "description": "End data of sale price.", - "type": "string", - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "download_type": { - "description": "Download type, this controls the schema on the front-end.", - "type": "string", - "enum": [ - "standard" - ], - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", - "type": "boolean", - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "variations": { - "description": "List of variations.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Variation ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created": { - "description": "The date the variation was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the variation was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "permalink": { - "description": "Variation URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "price": { - "description": "Current variation price.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "date_on_sale_from": { - "description": "Start date of sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "date_on_sale_to": { - "description": "End data of sale price.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "on_sale": { - "description": "Shows if the variation is on sale.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "purchasable": { - "description": "Shows if the variation can be bought.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "visible": { - "description": "If the variation is visible.", - "type": "boolean", - "context": [ - "view", - "edit" - ] - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "default": null, - "context": [ - "view", - "edit" - ] - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "default": null, - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "default": "taxable", - "enum": [ - "taxable", - "shipping", - "none" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "in_stock": { - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "default": true, - "context": [ - "view", - "edit" - ] - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "default": "no", - "enum": [ - "no", - "notify", - "yes" - ], - "context": [ - "view", - "edit" - ] - }, - "backorders_allowed": { - "description": "Shows if back-orders are allowed.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "backordered": { - "description": "Shows if the variation is on back-order.", - "type": "boolean", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "context": [ - "view", - "edit" - ], - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "shipping_class_id": { - "description": "Shipping class ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Variation image data.", - "type": "object", - "context": [ - "view", - "edit" - ], - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/batch" - } - ] - } - }, - "/wc/v1/reports/sales": { - "namespace": "wc/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - }, - "period": { - "description": "Report period.", - "type": "string", - "enum": [ - "week", - "month", - "last_month", - "year" - ], - "required": false - }, - "date_min": { - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - }, - "date_max": { - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/sales" - } - ] - } - }, - "/wc/v1/reports/top_sellers": { - "namespace": "wc/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - }, - "period": { - "description": "Report period.", - "type": "string", - "enum": [ - "week", - "month", - "last_month", - "year" - ], - "required": false - }, - "date_min": { - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - }, - "date_max": { - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/top_sellers" - } - ] - } - }, - "/wc/v1/reports": { - "namespace": "wc/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports" - } - ] - } - }, - "/wc/v1/taxes/classes": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Tax class name.", - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/classes" - } - ] - } - }, - "/wc/v1/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": { - "namespace": "wc/v1", - "methods": [ - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "DELETE" - ], - "args": { - "slug": { - "description": "Unique slug for the resource.", - "type": "string", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/taxes": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "order", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "order", - "priority" - ], - "type": "string", - "required": false - }, - "class": { - "description": "Sort by tax class.", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode / ZIP.", - "type": "string", - "required": false - }, - "city": { - "description": "City name.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "default": 1, - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "default": false, - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "default": true, - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "default": "standard", - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes" - } - ] - } - }, - "/wc/v1/taxes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode / ZIP.", - "type": "string", - "required": false - }, - "city": { - "description": "City name.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/taxes/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode / ZIP.", - "type": "string", - "required": false - }, - "city": { - "description": "City name.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/batch" - } - ] - } - }, - "/wc/v1/webhooks": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "title" - ], - "required": false - }, - "status": { - "default": "all", - "description": "Limit result set to webhooks assigned a specific status.", - "type": "string", - "enum": [ - "all", - "active", - "paused", - "disabled" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "default": "active", - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "type": "string", - "description": "Webhook topic.", - "required": true - }, - "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", - "required": false - }, - "delivery_url": { - "type": "string", - "description": "Webhook delivery URL.", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks" - } - ] - } - }, - "/wc/v1/webhooks/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "description": "Webhook topic.", - "type": "string", - "required": false - }, - "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", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v1/webhooks/batch": { - "namespace": "wc/v1", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "description": "Webhook topic.", - "type": "string", - "required": false - }, - "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", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks/batch" - } - ] - } - }, - "/wc/v1/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries": { - "namespace": "wc/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "webhook_id": { - "description": "Unique identifier for the webhook.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v1/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "webhook_id": { - "description": "Unique identifier for the webhook.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v2": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc/v2", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2" - } - ] - } - }, - "/wc/v2/coupons": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "code": { - "description": "Limit result set to resources with a specific code.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": true - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "default": "fixed_cart", - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "default": false, - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "default": false, - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "default": false, - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons" - } - ] - } - }, - "/wc/v2/coupons/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v2/coupons/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons/batch" - } - ] - } - }, - "/wc/v2/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "customer_id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v2/customers": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "name", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "include", - "name", - "registered_date" - ], - "type": "string", - "required": false - }, - "email": { - "description": "Limit result set to resources with a specific email.", - "type": "string", - "format": "email", - "required": false - }, - "role": { - "description": "Limit result set to resources with a specific role.", - "type": "string", - "default": "customer", - "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "email": { - "type": "string", - "description": "New user email address.", - "required": true - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "New user username.", - "type": "string", - "required": false - }, - "password": { - "description": "New user password.", - "type": "string", - "required": true - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers" - } - ] - } - }, - "/wc/v2/customers/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "email": { - "description": "The email address for the customer.", - "type": "string", - "format": "email", - "required": false - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "Customer login name.", - "type": "string", - "required": false - }, - "password": { - "description": "Customer password.", - "type": "string", - "required": false - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - }, - "reassign": { - "default": 0, - "type": "integer", - "description": "ID to reassign posts to.", - "required": false - } - } - } - ] - }, - "/wc/v2/customers/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "email": { - "description": "The email address for the customer.", - "type": "string", - "format": "email", - "required": false - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "Customer login name.", - "type": "string", - "required": false - }, - "password": { - "description": "Customer password.", - "type": "string", - "required": false - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers/batch" - } - ] - } - }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "type": { - "default": "any", - "description": "Limit result to customers or internal notes.", - "type": "string", - "enum": [ - "any", - "customer", - "internal" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "note": { - "type": "string", - "description": "Order note content.", - "required": true - }, - "customer_note": { - "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", - "required": false - } - } - } - ] - }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - }, - "order_item_display_meta": { - "default": false, - "description": "Only show meta which is meant to be displayed for an order.", - "type": "boolean", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "amount": { - "description": "Refund amount.", - "type": "string", - "required": false - }, - "reason": { - "description": "Reason for refund.", - "type": "string", - "required": false - }, - "refunded_by": { - "description": "User ID of user who created the refund.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "api_refund": { - "default": true, - "description": "When true, the payment gateway API is used to generate the refund.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc/v2/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/orders": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to orders assigned a specific status.", - "type": "string", - "enum": [ - "any", - "trash", - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "customer": { - "description": "Limit result set to orders assigned a specific customer.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to orders assigned a specific product.", - "type": "integer", - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - }, - "order_item_display_meta": { - "default": false, - "description": "Only show meta which is meant to be displayed for an order.", - "type": "boolean", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "default": "pending", - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "default": "EUR", - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "default": 0, - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "default": false, - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders" - } - ] - } - }, - "/wc/v2/orders/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v2/orders/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders/batch" - } - ] - } - }, - "/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc/v2/products/attributes": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Name for the resource.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "default": "select", - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "default": "menu_order", - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "default": false, - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes" - } - ] - } - }, - "/wc/v2/products/attributes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/products/attributes/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes/batch" - } - ] - } - }, - "/wc/v2/products/categories": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "default": "default", - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "title": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories" - } - ] - } - }, - "/wc/v2/products/categories/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "title": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/products/categories/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "title": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories/batch" - } - ] - } - }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "review": { - "type": "string", - "description": "Review content.", - "required": true - }, - "date_created": { - "description": "The date the review was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the review was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - }, - "name": { - "type": "string", - "description": "Name of the reviewer.", - "required": true - }, - "email": { - "type": "string", - "description": "Email of the reviewer.", - "required": true - } - } - } - ] - }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the review was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the review was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - }, - "name": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "email": { - "description": "Reviewer email.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/reviews/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the review was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the review was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - }, - "name": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "email": { - "description": "Reviewer email.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v2/products/shipping_classes": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes" - } - ] - } - }, - "/wc/v2/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Shipping class name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/products/shipping_classes/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Shipping class name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes/batch" - } - ] - } - }, - "/wc/v2/products/tags": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags" - } - ] - } - }, - "/wc/v2/products/tags/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Tag name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/products/tags/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Tag name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags/batch" - } - ] - } - }, - "/wc/v2/products": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "in_stock": { - "description": "Limit result set to products in stock or out of stock.", - "type": "boolean", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "type": { - "default": "simple", - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - }, - "featured": { - "default": false, - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "default": "visible", - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "default": true, - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", - "type": "boolean", - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "sold_individually": { - "default": false, - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "default": true, - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "string" - } - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "grouped_products": { - "description": "List of grouped products ID.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products" - } - ] - } - }, - "/wc/v2/products/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", - "type": "boolean", - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "string" - } - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "grouped_products": { - "description": "List of grouped products ID.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc/v2/products/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", - "type": "boolean", - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "string" - } - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "grouped_products": { - "description": "List of grouped products ID.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/batch" - } - ] - } - }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "in_stock": { - "description": "Limit result set to products in stock or out of stock.", - "type": "boolean", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "visible": { - "default": true, - "description": "Define if the variation is visible on the product's page.", - "type": "boolean", - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "default": true, - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ] - }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "visible": { - "description": "Define if the variation is visible on the product's page.", - "type": "boolean", - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v2/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Unique identifier.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "visible": { - "description": "Define if the variation is visible on the product's page.", - "type": "boolean", - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "in_stock": { - "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", - "type": "boolean", - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Image position. 0 means that the image is featured.", - "type": "integer", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ] - }, - "/wc/v2/reports/sales": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - }, - "period": { - "description": "Report period.", - "type": "string", - "enum": [ - "week", - "month", - "last_month", - "year" - ], - "required": false - }, - "date_min": { - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - }, - "date_max": { - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/sales" - } - ] - } - }, - "/wc/v2/reports/top_sellers": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - }, - "period": { - "description": "Report period.", - "type": "string", - "enum": [ - "week", - "month", - "last_month", - "year" - ], - "required": false - }, - "date_min": { - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - }, - "date_max": { - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/top_sellers" - } - ] - } - }, - "/wc/v2/reports": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports" - } - ] - } - }, - "/wc/v2/settings": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/settings" - } - ] - } - }, - "/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - } - ] - }, - "/wc/v2/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - } - ] - }, - "/wc/v2/shipping/zones": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Shipping zone name.", - "required": true - }, - "order": { - "description": "Shipping zone order.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping/zones" - } - ] - } - }, - "/wc/v2/shipping/zones/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Shipping zone name.", - "type": "string", - "required": false - }, - "order": { - "description": "Shipping zone order.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v2/shipping/zones/(?P\u003Cid\u003E[\\d]+)/locations": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - }, - "code": { - "description": "Shipping zone location code.", - "type": "string", - "required": false - }, - "type": { - "description": "Shipping zone location type.", - "type": "string", - "enum": [ - "postcode", - "state", - "country", - "continent" - ], - "required": false - } - } - } - ] - }, - "/wc/v2/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "order": { - "description": "Shipping method sort order.", - "type": "integer", - "required": false - }, - "enabled": { - "description": "Shipping method enabled status.", - "type": "boolean", - "required": false - }, - "settings": { - "description": "Shipping method settings.", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { - "description": "Setting value.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - }, - "required": false - }, - "method_id": { - "description": "Shipping method ID.", - "required": true - } - } - } - ] - }, - "/wc/v2/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods/(?P\u003Cinstance_id\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "instance_id": { - "description": "Unique ID for the instance.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "instance_id": { - "description": "Unique ID for the instance.", - "type": "integer", - "required": false - }, - "order": { - "description": "Shipping method sort order.", - "type": "integer", - "required": false - }, - "enabled": { - "description": "Shipping method enabled status.", - "type": "boolean", - "required": false - }, - "settings": { - "description": "Shipping method settings.", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { - "description": "Setting value.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "instance_id": { - "description": "Unique ID for the instance.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v2/taxes/classes": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Tax class name.", - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/classes" - } - ] - } - }, - "/wc/v2/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Unique slug for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "slug": { - "description": "Unique slug for the resource.", - "type": "string", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/taxes": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "order", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "order", - "priority" - ], - "type": "string", - "required": false - }, - "class": { - "description": "Sort by tax class.", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode / ZIP.", - "type": "string", - "required": false - }, - "city": { - "description": "City name.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "default": 1, - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "default": false, - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "default": true, - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "default": "standard", - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes" - } - ] - } - }, - "/wc/v2/taxes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode / ZIP.", - "type": "string", - "required": false - }, - "city": { - "description": "City name.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/taxes/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode / ZIP.", - "type": "string", - "required": false - }, - "city": { - "description": "City name.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/batch" - } - ] - } - }, - "/wc/v2/webhooks": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "title" - ], - "required": false - }, - "status": { - "default": "all", - "description": "Limit result set to webhooks assigned a specific status.", - "type": "string", - "enum": [ - "all", - "active", - "paused", - "disabled" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "default": "active", - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "type": "string", - "description": "Webhook topic.", - "required": true - }, - "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", - "required": false - }, - "delivery_url": { - "type": "string", - "description": "Webhook delivery URL.", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks" - } - ] - } - }, - "/wc/v2/webhooks/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "description": "Webhook topic.", - "type": "string", - "required": false - }, - "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", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v2/webhooks/batch": { - "namespace": "wc/v2", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "description": "Webhook topic.", - "type": "string", - "required": false - }, - "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", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks/batch" - } - ] - } - }, - "/wc/v2/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "webhook_id": { - "description": "Unique identifier for the webhook.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v2/webhooks/(?P\u003Cwebhook_id\u003E[\\d]+)/deliveries/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "webhook_id": { - "description": "Unique identifier for the webhook.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v2/system_status": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status" - } - ] - } - }, - "/wc/v2/system_status/tools": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status/tools" - } - ] - } - }, - "/wc/v2/system_status/tools/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "A unique identifier for the tool.", - "type": "string", - "required": false - }, - "name": { - "description": "Tool name.", - "type": "string", - "required": false - }, - "action": { - "description": "What running the tool will do.", - "type": "string", - "required": false - }, - "description": { - "description": "Tool description.", - "type": "string", - "required": false - }, - "success": { - "description": "Did the tool run successfully?", - "type": "boolean", - "required": false - }, - "message": { - "description": "Tool return message.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v2/shipping_methods": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping_methods" - } - ] - } - }, - "/wc/v2/shipping_methods/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v2/payment_gateways": { - "namespace": "wc/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/payment_gateways" - } - ] - } - }, - "/wc/v2/payment_gateways/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "title": { - "description": "Payment gateway title on checkout.", - "type": "string", - "required": false - }, - "description": { - "description": "Payment gateway description on checkout.", - "type": "string", - "required": false - }, - "order": { - "description": "Payment gateway sort order.", - "type": "integer", - "required": false - }, - "enabled": { - "description": "Payment gateway enabled status.", - "type": "boolean", - "required": false - }, - "settings": { - "description": "Payment gateway settings.", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { - "description": "Setting value.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - }, - "required": false - } - } - } - ] - }, - "/wc/v3/coupons": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "code": { - "description": "Limit result set to resources with a specific code.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": true - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "default": "fixed_cart", - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "default": false, - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "default": false, - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "default": false, - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons" - } - ] - } - }, - "/wc/v3/coupons/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v3/coupons/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "code": { - "description": "Coupon code.", - "type": "string", - "required": false - }, - "amount": { - "description": "The amount of discount. Should always be numeric, even if setting a percentage.", - "type": "string", - "required": false - }, - "status": { - "description": "The status of the coupon. Should always be draft, published, or pending review", - "type": "string", - "required": false - }, - "discount_type": { - "description": "Determines the type of discount that will be applied.", - "type": "string", - "enum": [ - "percent", - "fixed_cart", - "fixed_product" - ], - "required": false - }, - "description": { - "description": "Coupon description.", - "type": "string", - "required": false - }, - "date_expires": { - "description": "The date the coupon expires, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_expires_gmt": { - "description": "The date the coupon expires, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "individual_use": { - "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", - "type": "boolean", - "required": false - }, - "product_ids": { - "description": "List of product IDs the coupon can be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_ids": { - "description": "List of product IDs the coupon cannot be used on.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "usage_limit": { - "description": "How many times the coupon can be used in total.", - "type": "integer", - "required": false - }, - "usage_limit_per_user": { - "description": "How many times the coupon can be used per customer.", - "type": "integer", - "required": false - }, - "limit_usage_to_x_items": { - "description": "Max number of items in the basket the coupon can be applied to.", - "type": "integer", - "required": false - }, - "free_shipping": { - "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", - "type": "boolean", - "required": false - }, - "product_categories": { - "description": "List of category IDs the coupon applies to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "excluded_product_categories": { - "description": "List of category IDs the coupon does not apply to.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "exclude_sale_items": { - "description": "If true, this coupon will not be applied to items that have sale prices.", - "type": "boolean", - "required": false - }, - "minimum_amount": { - "description": "Minimum order amount that needs to be in the basket before coupon applies.", - "type": "string", - "required": false - }, - "maximum_amount": { - "description": "Maximum order amount allowed when using the coupon.", - "type": "string", - "required": false - }, - "email_restrictions": { - "description": "List of email addresses that can use this coupon.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons/batch" - } - ] - } - }, - "/wc/v3/customers/(?P\u003Ccustomer_id\u003E[\\d]+)/downloads": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "customer_id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v3/customers": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "name", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "include", - "name", - "registered_date" - ], - "type": "string", - "required": false - }, - "email": { - "description": "Limit result set to resources with a specific email.", - "type": "string", - "format": "email", - "required": false - }, - "role": { - "description": "Limit result set to resources with a specific role.", - "type": "string", - "default": "customer", - "enum": [ - "all", - "administrator", - "editor", - "author", - "contributor", - "subscriber", - "customer", - "shop_manager" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "email": { - "type": "string", - "description": "New user email address.", - "required": true - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "New user username.", - "type": "string", - "required": false - }, - "password": { - "description": "New user password.", - "type": "string", - "required": true - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers" - } - ] - } - }, - "/wc/v3/customers/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "email": { - "description": "The email address for the customer.", - "type": "string", - "format": "email", - "required": false - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "Customer login name.", - "type": "string", - "required": false - }, - "password": { - "description": "Customer password.", - "type": "string", - "required": false - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - }, - "reassign": { - "default": 0, - "type": "integer", - "description": "ID to reassign posts to.", - "required": false - } - } - } - ] - }, - "/wc/v3/customers/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "email": { - "description": "The email address for the customer.", - "type": "string", - "format": "email", - "required": false - }, - "first_name": { - "description": "Customer first name.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Customer last name.", - "type": "string", - "required": false - }, - "username": { - "description": "Customer login name.", - "type": "string", - "required": false - }, - "password": { - "description": "Customer password.", - "type": "string", - "required": false - }, - "billing": { - "description": "List of billing address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": "string", - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "List of shipping address data.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "ISO code of the country.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers/batch" - } - ] - } - }, - "/wc/v3/layout-templates": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "area": { - "description": "Area to get templates for.", - "type": "string", - "default": "", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/layout-templates" - } - ] - } - }, - "/wc/v3/layout-templates/(?P\u003Cid\u003E\\w[\\w\\s\\-]*)": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/notes": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "type": { - "default": "any", - "description": "Limit result to customers or internal notes.", - "type": "string", - "enum": [ - "any", - "customer", - "internal" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "note": { - "type": "string", - "description": "Order note content.", - "required": true - }, - "customer_note": { - "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", - "required": false - }, - "added_by_user": { - "default": false, - "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/notes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - }, - "order_item_display_meta": { - "default": false, - "description": "Only show meta which is meant to be displayed for an order.", - "type": "boolean", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "amount": { - "description": "Refund amount.", - "type": "string", - "required": false - }, - "reason": { - "description": "Reason for refund.", - "type": "string", - "required": false - }, - "refunded_by": { - "description": "User ID of user who created the refund.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "api_refund": { - "default": true, - "description": "When true, the payment gateway API is used to generate the refund.", - "type": "boolean", - "required": false - }, - "api_restock": { - "default": true, - "description": "When true, refunded items are restocked.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc/v3/orders/(?P\u003Corder_id\u003E[\\d]+)/refunds/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "order_id": { - "description": "The order ID.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/orders": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to orders which have specific statuses.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "any", - "trash", - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ] - }, - "required": false - }, - "customer": { - "description": "Limit result set to orders assigned a specific customer.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to orders assigned a specific product.", - "type": "integer", - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - }, - "order_item_display_meta": { - "default": false, - "description": "Only show meta which is meant to be displayed for an order.", - "type": "boolean", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "default": "pending", - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "default": "EUR", - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "default": 0, - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "default": false, - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "default": false, - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders" - } - ] - } - }, - "/wc/v3/orders/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v3/orders/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "parent_id": { - "description": "Parent order ID.", - "type": "integer", - "required": false - }, - "status": { - "description": "Order status.", - "type": "string", - "enum": [ - "auto-draft", - "pending", - "processing", - "on-hold", - "completed", - "cancelled", - "refunded", - "failed", - "checkout-draft" - ], - "required": false - }, - "currency": { - "description": "Currency the order was created with, in ISO format.", - "type": "string", - "enum": [ - "AED", - "AFN", - "ALL", - "AMD", - "ANG", - "AOA", - "ARS", - "AUD", - "AWG", - "AZN", - "BAM", - "BBD", - "BDT", - "BGN", - "BHD", - "BIF", - "BMD", - "BND", - "BOB", - "BRL", - "BSD", - "BTC", - "BTN", - "BWP", - "BYR", - "BYN", - "BZD", - "CAD", - "CDF", - "CHF", - "CLP", - "CNY", - "COP", - "CRC", - "CUC", - "CUP", - "CVE", - "CZK", - "DJF", - "DKK", - "DOP", - "DZD", - "EGP", - "ERN", - "ETB", - "EUR", - "FJD", - "FKP", - "GBP", - "GEL", - "GGP", - "GHS", - "GIP", - "GMD", - "GNF", - "GTQ", - "GYD", - "HKD", - "HNL", - "HRK", - "HTG", - "HUF", - "IDR", - "ILS", - "IMP", - "INR", - "IQD", - "IRR", - "IRT", - "ISK", - "JEP", - "JMD", - "JOD", - "JPY", - "KES", - "KGS", - "KHR", - "KMF", - "KPW", - "KRW", - "KWD", - "KYD", - "KZT", - "LAK", - "LBP", - "LKR", - "LRD", - "LSL", - "LYD", - "MAD", - "MDL", - "MGA", - "MKD", - "MMK", - "MNT", - "MOP", - "MRU", - "MUR", - "MVR", - "MWK", - "MXN", - "MYR", - "MZN", - "NAD", - "NGN", - "NIO", - "NOK", - "NPR", - "NZD", - "OMR", - "PAB", - "PEN", - "PGK", - "PHP", - "PKR", - "PLN", - "PRB", - "PYG", - "QAR", - "RON", - "RSD", - "RUB", - "RWF", - "SAR", - "SBD", - "SCR", - "SDG", - "SEK", - "SGD", - "SHP", - "SLL", - "SOS", - "SRD", - "SSP", - "STN", - "SYP", - "SZL", - "THB", - "TJS", - "TMT", - "TND", - "TOP", - "TRY", - "TTD", - "TWD", - "TZS", - "UAH", - "UGX", - "USD", - "UYU", - "UZS", - "VEF", - "VES", - "VND", - "VUV", - "WST", - "XAF", - "XCD", - "XOF", - "XPF", - "YER", - "ZAR", - "ZMW" - ], - "required": false - }, - "customer_id": { - "description": "User ID who owns the order. 0 for guests.", - "type": "integer", - "required": false - }, - "customer_note": { - "description": "Note left by customer during checkout.", - "type": "string", - "required": false - }, - "billing": { - "description": "Billing address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "email": { - "description": "Email address.", - "type": [ - "string", - "null" - ], - "format": "email", - "context": [ - "view", - "edit" - ] - }, - "phone": { - "description": "Phone number.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping": { - "description": "Shipping address.", - "type": "object", - "properties": { - "first_name": { - "description": "First name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "last_name": { - "description": "Last name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "company": { - "description": "Company name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_1": { - "description": "Address line 1", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "address_2": { - "description": "Address line 2", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "city": { - "description": "City name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "state": { - "description": "ISO code or name of the county, state, province or district.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "postcode": { - "description": "Postal code.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "country": { - "description": "Country code in ISO 3166-1 alpha-2 format.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "payment_method": { - "description": "Payment method ID.", - "type": "string", - "required": false - }, - "payment_method_title": { - "description": "Payment method title.", - "type": "string", - "required": false - }, - "transaction_id": { - "description": "Unique transaction ID.", - "type": "string", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "line_items": { - "description": "Line items data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Product name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "parent_name": { - "description": "Parent product name if the product is a variation.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "product_id": { - "description": "Product ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "variation_id": { - "description": "Variation ID, if applicable.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "quantity": { - "description": "Quantity ordered.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of product.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Line subtotal (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal_tax": { - "description": "Line subtotal tax (before discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "display_key": { - "description": "Meta key for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "display_value": { - "description": "Meta value for UI display.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "sku": { - "description": "Product SKU.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "price": { - "description": "Product price.", - "type": "number", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "image": { - "description": "Properties of the main product image.", - "type": "object", - "context": [ - "view", - "edit" - ], - "readonly": true, - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "shipping_lines": { - "description": "Shipping lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "method_title": { - "description": "Shipping method name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "method_id": { - "description": "Shipping method ID.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "instance_id": { - "description": "Shipping instance ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "fee_lines": { - "description": "Fee lines data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "name": { - "description": "Fee name.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "tax_class": { - "description": "Tax class of fee.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "tax_status": { - "description": "Tax status of fee.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "taxable", - "none" - ] - }, - "total": { - "description": "Line total (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "total_tax": { - "description": "Line total tax (after discounts).", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "taxes": { - "description": "Line taxes.", - "type": "array", - "context": [ - "view", - "edit" - ], - "readonly": true, - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tax rate ID", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "total": { - "description": "Tax total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "subtotal": { - "description": "Tax subtotal.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - } - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "coupon_lines": { - "description": "Coupons line data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Item ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "code": { - "description": "Coupon code.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - }, - "discount": { - "description": "Discount total.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_tax": { - "description": "Discount total tax.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "discount_type": { - "description": "Discount type.", - "type": "string", - "context": [ - "view" - ], - "readonly": true - }, - "nominal_amount": { - "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", - "type": "number", - "context": [ - "view" - ], - "readonly": true - }, - "free_shipping": { - "description": "Whether the coupon grants free shipping or not.", - "type": "boolean", - "context": [ - "view" - ], - "readonly": true - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "context": [ - "view", - "edit" - ], - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - } - }, - "required": false - }, - "set_paid": { - "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", - "type": "boolean", - "required": false - }, - "manual_update": { - "description": "Set the action as manual so that the order note registers as \"added by user\".", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders/batch" - } - ] - } - }, - "/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/products/attributes/(?P\u003Cattribute_id\u003E[\\d]+)/terms/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "attribute_id": { - "description": "Unique identifier for the attribute of the terms.", - "type": "integer", - "required": false - }, - "name": { - "description": "Term name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc/v3/products/attributes": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Name for the resource.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "default": "select", - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "default": "menu_order", - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "default": false, - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes" - } - ] - } - }, - "/wc/v3/products/attributes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": true, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/products/attributes/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Attribute name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of attribute.", - "type": "string", - "enum": [ - "select" - ], - "required": false - }, - "order_by": { - "description": "Default sort order.", - "type": "string", - "enum": [ - "menu_order", - "name", - "name_num", - "id" - ], - "required": false - }, - "has_archives": { - "description": "Enable/Disable attribute archives.", - "type": "boolean", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes/batch" - } - ] - } - }, - "/wc/v3/products/categories": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "default": "default", - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories" - } - ] - } - }, - "/wc/v3/products/categories/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/products/categories/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Category name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the resource.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - }, - "display": { - "description": "Category archive display type.", - "type": "string", - "enum": [ - "default", - "products", - "subcategories", - "both" - ], - "required": false - }, - "image": { - "description": "Image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort the resource.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories/batch" - } - ] - } - }, - "/wc/v3/products/custom-fields/names": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "order": { - "description": "Order sort items ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/custom-fields/names" - } - ] - } - }, - "/wc/v3/products/reviews": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to reviews published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date_gmt", - "enum": [ - "date", - "date_gmt", - "id", - "include", - "product" - ], - "required": false - }, - "reviewer": { - "description": "Limit result set to reviews assigned to specific user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "reviewer_exclude": { - "description": "Ensure result set excludes reviews assigned to specific user IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "reviewer_email": { - "default": null, - "description": "Limit result set to that from a specific author email.", - "format": "email", - "type": "string", - "required": false - }, - "product": { - "default": [], - "description": "Limit result set to reviews assigned to specific product IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "status": { - "default": "approved", - "description": "Limit result set to reviews assigned a specific status.", - "type": "string", - "enum": [ - "all", - "hold", - "approved", - "spam", - "trash" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the product.", - "type": "integer", - "required": true - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "default": "approved", - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "type": "string", - "description": "Name of the reviewer.", - "required": true - }, - "reviewer_email": { - "type": "string", - "description": "Email of the reviewer.", - "required": true - }, - "review": { - "type": "string", - "description": "Review content.", - "required": true - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews" - } - ] - } - }, - "/wc/v3/products/reviews/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "product_id": { - "description": "Unique identifier for the product that the review belongs to.", - "type": "integer", - "required": false - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "reviewer_email": { - "description": "Reviewer email.", - "type": "string", - "format": "email", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v3/products/reviews/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the product that the review belongs to.", - "type": "integer", - "required": false - }, - "product_name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of the review.", - "type": "string", - "enum": [ - "approved", - "hold", - "spam", - "unspam", - "trash", - "untrash" - ], - "required": false - }, - "reviewer": { - "description": "Reviewer name.", - "type": "string", - "required": false - }, - "reviewer_email": { - "description": "Reviewer email.", - "type": "string", - "format": "email", - "required": false - }, - "review": { - "description": "The content of the review.", - "type": "string", - "required": false - }, - "rating": { - "description": "Review rating (0 to 5).", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews/batch" - } - ] - } - }, - "/wc/v3/products/shipping_classes": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes" - } - ] - } - }, - "/wc/v3/products/shipping_classes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Shipping class name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/products/shipping_classes/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Shipping class name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/batch" - } - ] - } - }, - "/wc/v3/products/shipping_classes/slug-suggestion": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "name": { - "description": "Shipping class name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/slug-suggestion" - } - ] - } - }, - "/wc/v3/products/tags": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by resource attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide resources not assigned to any products.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", - "type": "integer", - "required": false - }, - "product": { - "description": "Limit result set to resources assigned to a specific product.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to resources with a specific slug.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Name for the resource.", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags" - } - ] - } - }, - "/wc/v3/products/tags/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Tag name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/products/tags/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Tag name.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the resource unique to its type.", - "type": "string", - "required": false - }, - "description": { - "description": "HTML description of the resource.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags/batch" - } - ] - } - }, - "/wc/v3/products": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order", - "price", - "popularity", - "rating" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "search_sku": { - "description": "Limit results to those with a SKU that partially matches a string.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "default": "simple", - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "default": false, - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "default": "visible", - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "default": false, - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "default": true, - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products" - } - ] - } - }, - "/wc/v3/products/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "description": "Whether to bypass bin and force deletion.", - "type": "boolean", - "required": false - } - } - } - ] - }, - "/wc/v3/products/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/batch" - } - ] - } - }, - "/wc/v3/products/suggested-products": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "popularity", - "rating", - "popularity", - "rating", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "type": { - "description": "Limit result set to products assigned a specific type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "featured": { - "description": "Limit result set to featured products.", - "type": "boolean", - "required": false - }, - "category": { - "description": "Limit result set to products assigned a specific category ID.", - "type": "string", - "required": false - }, - "tag": { - "description": "Limit result set to products assigned a specific tag ID.", - "type": "string", - "required": false - }, - "shipping_class": { - "description": "Limit result set to products assigned a specific shipping class ID.", - "type": "string", - "required": false - }, - "attribute": { - "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", - "type": "string", - "required": false - }, - "attribute_term": { - "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", - "type": "string", - "required": false - }, - "in_stock": { - "description": "Limit result set to products in stock or out of stock.", - "type": "boolean", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "categories": { - "description": "Limit result set to specific product categorie ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "tags": { - "description": "Limit result set to specific product tag ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "limit": { - "description": "Limit result set to specific amount of suggested products.", - "type": "integer", - "default": 5, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/suggested-products" - } - ] - } - }, - "/wc/v3/products/(?P\u003Cid\u003E[\\d]+)/duplicate": { - "namespace": "wc/v3", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Product name.", - "type": "string", - "required": false - }, - "slug": { - "description": "Product slug.", - "type": "string", - "required": false - }, - "date_created": { - "description": "The date the product was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_created_gmt": { - "description": "The date the product was created, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "type": { - "description": "Product type.", - "type": "string", - "enum": [ - "simple", - "grouped", - "external", - "variable" - ], - "required": false - }, - "status": { - "description": "Product status (post status).", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish", - "future", - "auto-draft", - "trash" - ], - "required": false - }, - "featured": { - "description": "Featured product.", - "type": "boolean", - "required": false - }, - "catalog_visibility": { - "description": "Catalogue visibility.", - "type": "string", - "enum": [ - "visible", - "catalog", - "search", - "hidden" - ], - "required": false - }, - "description": { - "description": "Product description.", - "type": "string", - "required": false - }, - "short_description": { - "description": "Product short description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Product regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Product sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "virtual": { - "description": "If the product is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the product is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "external_url": { - "description": "Product external URL. Only for external products.", - "type": "string", - "format": "uri", - "required": false - }, - "button_text": { - "description": "Product external button text. Only for external products.", - "type": "string", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at product level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the product.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "sold_individually": { - "description": "Allow one item to be bought in a single order.", - "type": "boolean", - "required": false - }, - "weight": { - "description": "Product weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Product dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Product length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Product width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Product height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "reviews_allowed": { - "description": "Allow reviews.", - "type": "boolean", - "required": false - }, - "post_password": { - "description": "Post password.", - "type": "string", - "required": false - }, - "upsell_ids": { - "description": "List of up-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "cross_sell_ids": { - "description": "List of cross-sell products IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_id": { - "description": "Product parent ID.", - "type": "integer", - "required": false - }, - "purchase_note": { - "description": "Optional note to send the customer after purchase.", - "type": "string", - "required": false - }, - "categories": { - "description": "List of categories.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Category ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Category name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Category slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "tags": { - "description": "List of tags.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Tag ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Tag name.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "slug": { - "description": "Tag slug.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - } - }, - "required": false - }, - "images": { - "description": "List of images.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "position": { - "description": "Attribute position.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "visible": { - "description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "variation": { - "description": "Define if the attribute can be used as variation.", - "type": "boolean", - "default": false, - "context": [ - "view", - "edit" - ] - }, - "options": { - "description": "List of available term names of the attribute.", - "type": "array", - "items": { - "type": "string" - }, - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "default_attributes": { - "description": "Defaults variation attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ] - }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified", - "menu_order" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "slug": { - "description": "Limit result set to products with a specific slug.", - "type": "string", - "required": false - }, - "status": { - "default": "any", - "description": "Limit result set to products assigned a specific status.", - "type": "string", - "enum": [ - "any", - "future", - "trash", - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "sku": { - "description": "Limit result set to products with specific SKU(s). Use commas to separate.", - "type": "string", - "required": false - }, - "on_sale": { - "description": "Limit result set to products on sale.", - "type": "boolean", - "required": false - }, - "min_price": { - "description": "Limit result set to products based on a minimum price.", - "type": "string", - "required": false - }, - "max_price": { - "description": "Limit result set to products based on a maximum price.", - "type": "string", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "stock_status": { - "description": "Limit result set to products with specified stock status.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "has_price": { - "description": "Limit result set to products with or without price.", - "type": "boolean", - "required": false - }, - "attributes": { - "description": "Limit result set to products with specified attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "attribute": { - "type": "string", - "description": "Attribute slug." - }, - "term": { - "type": "string", - "description": "Attribute term." - }, - "terms": { - "type": "array", - "description": "Attribute terms." - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ] - }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the variation.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ] - }, - "/wc/v3/products/(?P\u003Cproduct_id\u003E[\\d]+)/variations/generate": { - "namespace": "wc/v3", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "product_id": { - "description": "Unique identifier for the variable product.", - "type": "integer", - "required": false - }, - "delete": { - "description": "Deletes unused variations.", - "type": "boolean", - "required": false - }, - "default_values": { - "description": "Default values for generated variations.", - "type": "object", - "properties": { - "description": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation description.", - "type": "string" - }, - "sku": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock Keeping Unit.", - "type": "string" - }, - "global_unique_id": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string" - }, - "regular_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation regular price.", - "type": "string" - }, - "sale_price": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation sale price.", - "type": "string" - }, - "date_on_sale_from": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_from_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "date_on_sale_to_gmt": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ] - }, - "status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ] - }, - "virtual": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is virtual.", - "type": "boolean" - }, - "downloadable": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If the variation is downloadable.", - "type": "boolean" - }, - "downloads": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "download_limit": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer" - }, - "download_expiry": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Number of days until access to downloadable files expires.", - "type": "integer" - }, - "tax_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ] - }, - "tax_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Tax class.", - "type": "string" - }, - "manage_stock": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock management at variation level.", - "type": "boolean" - }, - "stock_quantity": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Stock quantity.", - "type": "integer" - }, - "stock_status": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ] - }, - "backorders": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ] - }, - "low_stock_amount": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ] - }, - "weight": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation weight (kg).", - "type": "string" - }, - "dimensions": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "shipping_class": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Shipping class slug.", - "type": "string" - }, - "image": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "attributes": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - } - }, - "menu_order": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Menu order, used to custom sort products.", - "type": "integer" - }, - "meta_data": { - "validate_callback": "rest_validate_request_arg", - "sanitize_callback": "rest_sanitize_request_arg", - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - } - } - }, - "required": false - }, - "description": { - "description": "Variation description.", - "type": "string", - "required": false - }, - "sku": { - "description": "Stock Keeping Unit.", - "type": "string", - "required": false - }, - "global_unique_id": { - "description": "GTIN, UPC, EAN or ISBN.", - "type": "string", - "required": false - }, - "regular_price": { - "description": "Variation regular price.", - "type": "string", - "required": false - }, - "sale_price": { - "description": "Variation sale price.", - "type": "string", - "required": false - }, - "date_on_sale_from": { - "description": "Start date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_from_gmt": { - "description": "Start date of sale price, as GMT.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "date_on_sale_to_gmt": { - "description": "End date of sale price, in the site's timezone.", - "type": [ - "null", - "string" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "Variation status.", - "type": "string", - "enum": [ - "draft", - "pending", - "private", - "publish" - ], - "required": false - }, - "virtual": { - "default": false, - "description": "If the variation is virtual.", - "type": "boolean", - "required": false - }, - "downloadable": { - "default": false, - "description": "If the variation is downloadable.", - "type": "boolean", - "required": false - }, - "downloads": { - "description": "List of downloadable files.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "File ID.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "File name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "file": { - "description": "File URL.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "download_limit": { - "default": -1, - "description": "Number of times downloadable files can be downloaded after purchase.", - "type": "integer", - "required": false - }, - "download_expiry": { - "default": -1, - "description": "Number of days until access to downloadable files expires.", - "type": "integer", - "required": false - }, - "tax_status": { - "default": "taxable", - "description": "Tax status.", - "type": "string", - "enum": [ - "taxable", - "shipping", - "none" - ], - "required": false - }, - "tax_class": { - "description": "Tax class.", - "type": "string", - "required": false - }, - "manage_stock": { - "default": false, - "description": "Stock management at variation level.", - "type": "boolean", - "required": false - }, - "stock_quantity": { - "description": "Stock quantity.", - "type": "integer", - "required": false - }, - "stock_status": { - "default": "instock", - "description": "Controls the stock status of the product.", - "type": "string", - "enum": [ - "instock", - "outofstock", - "onbackorder" - ], - "required": false - }, - "backorders": { - "default": "no", - "description": "If managing stock, this controls if back-orders are allowed.", - "type": "string", - "enum": [ - "no", - "notify", - "yes" - ], - "required": false - }, - "low_stock_amount": { - "description": "Low Stock amount for the variation.", - "type": [ - "integer", - "null" - ], - "required": false - }, - "weight": { - "description": "Variation weight (kg).", - "type": "string", - "required": false - }, - "dimensions": { - "description": "Variation dimensions.", - "type": "object", - "properties": { - "length": { - "description": "Variation length (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "width": { - "description": "Variation width (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "height": { - "description": "Variation height (cm).", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "shipping_class": { - "description": "Shipping class slug.", - "type": "string", - "required": false - }, - "image": { - "description": "Variation image data.", - "type": "object", - "properties": { - "id": { - "description": "Image ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "date_created": { - "description": "The date the image was created, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_created_gmt": { - "description": "The date the image was created, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified": { - "description": "The date the image was last modified, in the site's timezone.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "date_modified_gmt": { - "description": "The date the image was last modified, as GMT.", - "type": [ - "null", - "string" - ], - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "src": { - "description": "Image URL.", - "type": "string", - "format": "uri", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Image name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "alt": { - "description": "Image alternative text.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "attributes": { - "description": "List of attributes.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Attribute ID.", - "type": "integer", - "context": [ - "view", - "edit" - ] - }, - "name": { - "description": "Attribute name.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "option": { - "description": "Selected attribute term name.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - }, - "menu_order": { - "description": "Menu order, used to custom sort products.", - "type": "integer", - "required": false - }, - "meta_data": { - "description": "Meta data.", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "Meta ID.", - "type": "integer", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "key": { - "description": "Meta key.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "value": { - "description": "Meta value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "context": [ - "view", - "edit" - ] - } - } - }, - "required": false - } - } - } - ] - }, - "/wc/v3/refunds": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to resources modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to resources modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "dates_are_gmt": { - "description": "Whether to consider GMT post dates when limiting response by published or modified date.", - "type": "boolean", - "default": false, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "title", - "slug", - "modified" - ], - "required": false - }, - "parent": { - "description": "Limit result set to those of particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "dp": { - "default": 2, - "description": "Number of decimal points to use in each resource.", - "type": "integer", - "required": false - }, - "order_item_display_meta": { - "default": false, - "description": "Only show meta which is meant to be displayed for an order.", - "type": "boolean", - "required": false - }, - "include_meta": { - "default": [], - "description": "Limit meta_data to specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "exclude_meta": { - "default": [], - "description": "Ensure meta_data excludes specific keys.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/refunds" - } - ] - } - }, - "/wc/v3/reports/sales": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - }, - "period": { - "description": "Report period.", - "type": "string", - "enum": [ - "week", - "month", - "last_month", - "year" - ], - "required": false - }, - "date_min": { - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - }, - "date_max": { - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/sales" - } - ] - } - }, - "/wc/v3/reports/top_sellers": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - }, - "period": { - "description": "Report period.", - "type": "string", - "enum": [ - "week", - "month", - "last_month", - "year" - ], - "required": false - }, - "date_min": { - "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - }, - "date_max": { - "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", - "type": "string", - "format": "date", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/top_sellers" - } - ] - } - }, - "/wc/v3/reports/orders/totals": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/orders/totals" - } - ] - } - }, - "/wc/v3/reports/products/totals": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/products/totals" - } - ] - } - }, - "/wc/v3/reports/customers/totals": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/customers/totals" - } - ] - } - }, - "/wc/v3/reports/coupons/totals": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/coupons/totals" - } - ] - } - }, - "/wc/v3/reports/reviews/totals": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/reviews/totals" - } - ] - } - }, - "/wc/v3/reports": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports" - } - ] - } - }, - "/wc/v3/settings": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings" - } - ] - } - }, - "/wc/v3/settings/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings/batch" - } - ] - } - }, - "/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - } - ] - }, - "/wc/v3/settings/(?P\u003Cgroup_id\u003E[\\w-]+)/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "group": { - "description": "Settings group ID.", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "value": { - "description": "Setting value.", - "type": [ - "null", - "object", - "string", - "number", - "boolean", - "integer", - "array" - ], - "required": false - } - } - } - ] - }, - "/wc/v3/shipping/zones": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "type": "string", - "description": "Shipping zone name.", - "required": true - }, - "order": { - "description": "Shipping zone order.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping/zones" - } - ] - } - }, - "/wc/v3/shipping/zones/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "Shipping zone name.", - "type": "string", - "required": false - }, - "order": { - "description": "Shipping zone order.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v3/shipping/zones/(?P\u003Cid\u003E[\\d]+)/locations": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique ID for the resource.", - "type": "integer", - "required": false - }, - "code": { - "description": "Shipping zone location code.", - "type": "string", - "required": false - }, - "type": { - "description": "Shipping zone location type.", - "type": "string", - "enum": [ - "postcode", - "state", - "country", - "continent" - ], - "required": false - } - } - } - ] - }, - "/wc/v3/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "order": { - "description": "Shipping method sort order.", - "type": "integer", - "required": false - }, - "enabled": { - "description": "Shipping method enabled status.", - "type": "boolean", - "required": false - }, - "settings": { - "description": "Shipping method settings.", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox", - "class", - "order" - ], - "readonly": true - }, - "value": { - "description": "Setting value.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - }, - "required": false - }, - "method_id": { - "description": "Shipping method ID.", - "required": true - } - } - } - ] - }, - "/wc/v3/shipping/zones/(?P\u003Czone_id\u003E[\\d]+)/methods/(?P\u003Cinstance_id\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "instance_id": { - "description": "Unique ID for the instance.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "instance_id": { - "description": "Unique ID for the instance.", - "type": "integer", - "required": false - }, - "order": { - "description": "Shipping method sort order.", - "type": "integer", - "required": false - }, - "enabled": { - "description": "Shipping method enabled status.", - "type": "boolean", - "required": false - }, - "settings": { - "description": "Shipping method settings.", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox", - "class", - "order" - ], - "readonly": true - }, - "value": { - "description": "Setting value.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "zone_id": { - "description": "Unique ID for the zone.", - "type": "integer", - "required": false - }, - "instance_id": { - "description": "Unique ID for the instance.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Whether to bypass bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wc/v3/taxes/classes": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "Tax class name.", - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/classes" - } - ] - } - }, - "/wc/v3/taxes/classes/(?P\u003Cslug\u003E\\w[\\w\\s\\-]*)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "Unique slug for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "slug": { - "description": "Unique slug for the resource.", - "type": "string", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/taxes": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "order", - "description": "Sort collection by object attribute.", - "enum": [ - "id", - "order", - "priority" - ], - "type": "string", - "required": false - }, - "class": { - "description": "Sort by tax class.", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "default": 1, - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "default": false, - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "default": true, - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "default": "standard", - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes" - } - ] - } - }, - "/wc/v3/taxes/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/taxes/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "country": { - "description": "Country ISO 3166 code.", - "type": "string", - "required": false - }, - "state": { - "description": "State code.", - "type": "string", - "required": false - }, - "postcode": { - "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", - "type": "string", - "required": false - }, - "city": { - "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", - "type": "string", - "required": false - }, - "rate": { - "description": "Tax rate.", - "type": "string", - "required": false - }, - "name": { - "description": "Tax rate name.", - "type": "string", - "required": false - }, - "priority": { - "description": "Tax priority.", - "type": "integer", - "required": false - }, - "compound": { - "description": "Whether or not this is a compound rate.", - "type": "boolean", - "required": false - }, - "shipping": { - "description": "Whether or not this tax rate also gets applied to shipping.", - "type": "boolean", - "required": false - }, - "order": { - "description": "Indicates the order that will appear in queries.", - "type": "integer", - "required": false - }, - "class": { - "description": "Tax class.", - "type": "string", - "enum": [ - "standard", - "reduced-rate", - "zero-rate" - ], - "required": false - }, - "postcodes": { - "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "cities": { - "description": "List of city names. Introduced in WooCommerce 5.3.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/batch" - } - ] - } - }, - "/wc/v3/webhooks": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to resources published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to resources published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific ids.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "title" - ], - "required": false - }, - "status": { - "default": "all", - "description": "Limit result set to webhooks assigned a specific status.", - "type": "string", - "enum": [ - "all", - "active", - "paused", - "disabled" - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "default": "active", - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "type": "string", - "description": "Webhook topic.", - "required": true - }, - "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", - "required": false - }, - "delivery_url": { - "type": "string", - "description": "Webhook delivery URL.", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks" - } - ] - } - }, - "/wc/v3/webhooks/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "description": "Webhook topic.", - "type": "string", - "required": false - }, - "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", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "integer", - "required": false - }, - "force": { - "default": false, - "type": "boolean", - "description": "Required to be true, as resource does not support binning.", - "required": false - } - } - } - ] - }, - "/wc/v3/webhooks/batch": { - "namespace": "wc/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "name": { - "description": "A friendly name for the webhook.", - "type": "string", - "required": false - }, - "status": { - "description": "Webhook status.", - "type": "string", - "enum": [ - "active", - "paused", - "disabled" - ], - "required": false - }, - "topic": { - "description": "Webhook topic.", - "type": "string", - "required": false - }, - "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", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks/batch" - } - ] - } - }, - "/wc/v3/system_status": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status" - } - ] - } - }, - "/wc/v3/system_status/tools": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status/tools" - } - ] - } - }, - "/wc/v3/system_status/tools/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "A unique identifier for the tool.", - "type": "string", - "required": false - }, - "name": { - "description": "Tool name.", - "type": "string", - "required": false - }, - "action": { - "description": "What running the tool will do.", - "type": "string", - "required": false - }, - "description": { - "description": "Tool description.", - "type": "string", - "required": false - }, - "success": { - "description": "Did the tool run successfully?", - "type": "boolean", - "required": false - }, - "message": { - "description": "Tool return message.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v3/shipping_methods": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping_methods" - } - ] - } - }, - "/wc/v3/shipping_methods/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wc/v3/payment_gateways": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/payment_gateways" - } - ] - } - }, - "/wc/v3/payment_gateways/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wc/v3", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the resource.", - "type": "string", - "required": false - }, - "title": { - "description": "Payment gateway title on checkout.", - "type": "string", - "required": false - }, - "description": { - "description": "Payment gateway description on checkout.", - "type": "string", - "required": false - }, - "order": { - "description": "Payment gateway sort order.", - "type": "integer", - "required": false - }, - "enabled": { - "description": "Payment gateway enabled status.", - "type": "boolean", - "required": false - }, - "settings": { - "description": "Payment gateway settings.", - "type": "object", - "properties": { - "id": { - "description": "A unique identifier for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "label": { - "description": "A human readable label for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "description": { - "description": "A human readable description for the setting used in interfaces.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "type": { - "description": "Type of setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "enum": [ - "text", - "email", - "number", - "color", - "password", - "textarea", - "select", - "multiselect", - "radio", - "image_width", - "checkbox" - ], - "readonly": true - }, - "value": { - "description": "Setting value.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "default": { - "description": "Default value for the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "tip": { - "description": "Additional help text shown to the user about the setting.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "placeholder": { - "description": "Placeholder text to be displayed in text inputs.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - }, - "required": false - } - } - } - ] - }, - "/wc/v3/data": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data" - } - ] - } - }, - "/wc/v3/data/continents": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/continents" - } - ] - } - }, - "/wc/v3/data/continents/(?P\u003Clocation\u003E[\\w-]+)": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "continent": { - "description": "2 character continent code.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v3/data/countries": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/countries" - } - ] - } - }, - "/wc/v3/data/countries/(?P\u003Clocation\u003E[\\w-]+)": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "location": { - "description": "ISO3166 alpha-2 country code.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v3/data/currencies": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies" - } - ] - } - }, - "/wc/v3/data/currencies/current": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies/current" - } - ] - } - }, - "/wc/v3/data/currencies/(?P\u003Ccurrency\u003E[\\w-]{3})": { - "namespace": "wc/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "location": { - "description": "ISO4217 currency code.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wc/v3/orders/(?P\u003Cid\u003E[\\d]+)/receipt": { - "namespace": "wc/v3", - "methods": [ - "POST", - "GET" - ], - "endpoints": [ - { "methods": [ "POST" - ], - "args": { - "id": { - "description": "Unique identifier of the order.", - "type": "integer", - "required": false - }, - "expiration_date": { - "description": "Expiration date formatted as dd-mm-yyyy.", - "type": "string", - "default": null, - "required": false - }, - "expiration_days": { - "description": "Number of days to be added to the current date to get the expiration date.", - "type": "integer", - "default": 1, - "required": false - }, - "force_new": { - "description": "True to force the creation of a new receipt even if one already exists and has not expired yet.", - "type": "boolean", - "default": false, - "required": false - } - } - }, - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier of the order.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wc-telemetry": { - "namespace": "wc-telemetry", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wc-telemetry", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } + ] } ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry" - } - ] - } - }, - "/wc-telemetry/tracker": { - "namespace": "wc-telemetry", "methods": [ "POST" ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "platform": { - "description": "Platform to track.", - "type": "string", - "required": true - }, - "version": { - "description": "Platform version to track.", - "type": "string", - "required": true - }, - "installation_date": { - "description": "Installation date of the WooCommerce mobile app.", - "type": "string", - "format": "date-time", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry/tracker" - } - ] - } - }, - "/wccom-site/v3": { - "namespace": "wccom-site/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wccom-site/v3", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3" - } - ] - } - }, - "/wccom-site/v3/installer": { - "namespace": "wccom-site/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product-id": { - "type": "integer", - "required": true - }, - "run-until-step": { - "type": "string", - "enum": [ - "get_product_info", - "download_product", - "unpack_product", - "move_product", - "activate_product" - ], - "required": true - }, - "idempotency-key": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer" - } - ] - } - }, - "/wccom-site/v3/installer/reset": { - "namespace": "wccom-site/v3", - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "product-id": { - "type": "integer", - "required": true - }, - "idempotency-key": { - "type": "string", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer/reset" - } - ] - } - }, - "/wccom-site/v3/ssr": { - "namespace": "wccom-site/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/ssr" - } - ] - } - }, - "/wccom-site/v3/status": { - "namespace": "wccom-site/v3", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/status" - } - ] - } + "namespace": "" }, "/carbon-fields/v1": { - "namespace": "carbon-fields/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "carbon-fields/v1", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1" } ] - } - }, - "/carbon-fields/v1/posts/(?P\u003Cid\u003E\\d+)": { - "namespace": "carbon-fields/v1", + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "carbon-fields/v1", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/carbon-fields/v1/terms/(?P\u003Cid\u003E\\d+)": { - "namespace": "carbon-fields/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/carbon-fields/v1/users/(?P\u003Cid\u003E\\d+)": { - "namespace": "carbon-fields/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/carbon-fields/v1/comments/(?P\u003Cid\u003E\\d+)": { - "namespace": "carbon-fields/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ] - }, - "/carbon-fields/v1/options": { - "namespace": "carbon-fields/v1", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET", - "POST" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/options" - } - ] - } + "namespace": "carbon-fields/v1" }, "/carbon-fields/v1/association": { - "namespace": "carbon-fields/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/association" } ] - } - }, - "/carbon-fields/v1/association/options": { - "namespace": "carbon-fields/v1", + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], + "namespace": "carbon-fields/v1" + }, + "/carbon-fields/v1/association/options": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/association/options" } ] - } - }, - "/carbon-fields/v1/attachment": { - "namespace": "carbon-fields/v1", + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "type": { - "type": "string", - "description": "The requested type: ID or URL.", - "required": true - }, - "value": { - "type": "string", - "description": "The ID / URL of the attachment", - "required": true - } - } - } - ], + "namespace": "carbon-fields/v1" + }, + "/carbon-fields/v1/attachment": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/attachment" } ] - } - }, - "/carbon-fields/v1/block-renderer": { - "namespace": "carbon-fields/v1", - "methods": [ - "POST" - ], + }, "endpoints": [ { - "methods": [ - "POST" - ], "args": { - "name": { - "type": "string", - "description": "The name of the block.", - "required": true + "type": { + "description": "The requested type: ID or URL.", + "required": true, + "type": "string" }, - "content": { - "type": "string", - "description": "The content of the block.", - "required": true - }, - "post_id": { - "type": "integer", - "description": "ID of the post context.", - "required": false + "value": { + "description": "The ID / URL of the attachment", + "required": true, + "type": "string" } - } + }, + "methods": [ + "GET" + ] } ], + "methods": [ + "GET" + ], + "namespace": "carbon-fields/v1" + }, + "/carbon-fields/v1/block-renderer": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/block-renderer" } ] - } + }, + "endpoints": [ + { + "args": { + "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.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "carbon-fields/v1" }, - "/wp/v2": { - "namespace": "wp/v2", + "/carbon-fields/v1/comments/(?P\\d+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], + "namespace": "carbon-fields/v1" + }, + "/carbon-fields/v1/options": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/carbon-fields/v1/options" + } + ] + }, "endpoints": [ { + "args": [], + "methods": [ + "GET", + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "carbon-fields/v1" + }, + "/carbon-fields/v1/posts/(?P\\d+)": { + "endpoints": [ + { + "args": [], "methods": [ "GET" - ], + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "carbon-fields/v1" + }, + "/carbon-fields/v1/terms/(?P\\d+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "carbon-fields/v1" + }, + "/carbon-fields/v1/users/(?P\\d+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "carbon-fields/v1" + }, + "/jetpack/v4": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4" + } + ] + }, + "endpoints": [ + { "args": { - "namespace": { - "default": "wp/v2", - "required": false - }, "context": { "default": "view", "required": false + }, + "namespace": { + "default": "jetpack/v4", + "required": false } - } + }, + "methods": [ + "GET" + ] } ], + "methods": [ + "GET" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/connection": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": { + "isActive": { + "description": "Set to false will trigger the site to disconnect.", + "required": true + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/connection/authorize_url": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/authorize_url" + } + ] + }, + "endpoints": [ + { + "args": { + "redirect_uri": { + "description": "URI of the admin page where the user should be redirected after connection flow", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/connection/data": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/data" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/connection/owner": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/owner" + } + ] + }, + "endpoints": [ + { + "args": { + "owner": { + "description": "New owner", + "required": true, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/connection/plugins": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/plugins" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/connection/reconnect": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/reconnect" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/connection/register": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/connection/register" + } + ] + }, + "endpoints": [ + { + "args": { + "from": { + "description": "Indicates where the registration action was triggered for tracking/segmentation purposes", + "required": false, + "type": "string" + }, + "plugin_slug": { + "description": "Indicates from what plugin the request is coming from", + "required": false, + "type": "string" + }, + "redirect_uri": { + "description": "URI of the admin page where the user should be redirected after connection flow", + "required": false, + "type": "string" + }, + "registration_nonce": { + "description": "The registration nonce", + "required": true, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/remote_authorize": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/remote_authorize" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/user-token": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/user-token" + } + ] + }, + "endpoints": [ + { + "args": { + "is_connection_owner": { + "description": "Is connection owner", + "required": false, + "type": "boolean" + }, + "user_token": { + "description": "New user token", + "required": true, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/verify_registration": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_registration" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "jetpack/v4" + }, + "/jetpack/v4/verify_xmlrpc_error": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/jetpack/v4/verify_xmlrpc_error" + } + ] + }, + "endpoints": [ + { + "args": { + "nonce": { + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "jetpack/v4" + }, + "/wc-admin": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc-admin", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/experiments/assignment": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/experiments/assignment" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/features": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/features" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/launch-your-store/initialize-coming-soon": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/initialize-coming-soon" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/launch-your-store/survey-completed": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/survey-completed" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/launch-your-store/update-survey-status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/update-survey-status" + } + ] + }, + "endpoints": [ + { + "args": { + "status": { + "enum": [ + "no", + "yes" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/launch-your-store/woopayments/test-orders": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE" + ], + "namespace": "wc-admin" + }, + "/wc-admin/launch-your-store/woopayments/test-orders/count": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/launch-your-store/woopayments/test-orders/count" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/campaign-types": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaign-types" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/campaigns": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/campaigns" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/channels": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/channels" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/knowledge-base": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/knowledge-base" + } + ] + }, + "endpoints": [ + { + "args": { + "category": { + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/overview/activate-plugin": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/activate-plugin" + } + ] + }, + "endpoints": [ + { + "args": { + "plugin": { + "required": true, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/overview/installed-plugins": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/overview/installed-plugins" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/recommendations": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommendations" + } + ] + }, + "endpoints": [ + { + "args": { + "category": { + "enum": [ + "channels", + "extensions" + ], + "required": true, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/marketing/recommended": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/marketing/recommended" + } + ] + }, + "endpoints": [ + { + "args": { + "category": { + "required": false, + "type": "string" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/mobile-app": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/mobile-app/send-magic-link": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/mobile-app/send-magic-link" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/navigation/favorites/me": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/navigation/favorites/me" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": { + "item_id": { + "required": true + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "item_id": { + "required": true + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/notice/dismiss": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/notice/dismiss" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/free-extensions": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/free-extensions" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/plugins/install-and-activate": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/plugins/install-and-activate-async": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/install-and-activate-async" + } + ] + }, + "endpoints": [ + { + "args": { + "plugins": { + "description": "A list of plugins to install", + "items": "string", + "required": true, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/plugins/jetpack-authorization-url": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/plugins/jetpack-authorization-url" + } + ] + }, + "endpoints": [ + { + "args": { + "from": { + "default": "woocommerce-onboarding", + "description": "from value for the jetpack authorization page", + "required": false, + "type": "string" + }, + "redirect_url": { + "description": "The URL to redirect to after authorization", + "required": true, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/plugins/scheduled-installs/(?P\\w+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/product-types": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/product-types" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/products" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/profile": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": { + "business_extensions": { + "description": "Extra business extensions to install.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "completed": { + "description": "Whether or not the profile was completed.", + "required": false, + "type": "boolean" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "industry": { + "description": "Industry.", + "items": { + "type": "object" + }, + "required": false, + "type": "array" + }, + "is_agree_marketing": { + "description": "Whether or not this store agreed to receiving marketing contents from WooCommerce.com.", + "required": false, + "type": "boolean" + }, + "is_plugins_page_skipped": { + "description": "Whether or not plugins step in core profiler was skipped.", + "required": false, + "type": "boolean" + }, + "is_store_country_set": { + "description": "Whether or not this store country is set via onboarding profiler.", + "required": false, + "type": "boolean" + }, + "number_employees": { + "description": "Number of employees of the store.", + "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": [ + "amazon", + "bigcommerce", + "ebay", + "etsy", + "magento", + "other", + "shopify", + "squarespace", + "wix" + ], + "required": false, + "type": "string" + }, + "other_platform_name": { + "description": "Name of other platform used to sell (not listed).", + "required": false, + "type": "string" + }, + "product_count": { + "description": "Number of products to be added.", + "enum": [ + "0", + "1-10", + "1000+", + "101-1000", + "11-100" + ], + "required": false, + "type": "string" + }, + "product_types": { + "description": "Types of products sold.", + "items": { + "enum": [ + "bookings", + "downloads", + "memberships", + "physical", + "product-add-ons", + "product-bundles", + "subscriptions" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "revenue": { + "description": "Current annual revenue of the store.", + "enum": [ + "10000-50000", + "2500-10000", + "50000-250000", + "more-than-250000", + "none", + "rather-not-say", + "up-to-2500" + ], + "required": false, + "type": "string" + }, + "selling_venues": { + "description": "Other places the store is selling products.", + "enum": [ + "brick-mortar", + "brick-mortar-other", + "no", + "other", + "other-woocommerce" + ], + "required": false, + "type": "string" + }, + "setup_client": { + "description": "Whether or not this store was setup for a client.", + "required": false, + "type": "boolean" + }, + "skipped": { + "description": "Whether or not the profile was skipped.", + "required": false, + "type": "boolean" + }, + "store_email": { + "description": "Store email address.", + "required": false, + "type": "string" + }, + "theme": { + "description": "Selected store theme.", + "required": false, + "type": "string" + }, + "wccom_connected": { + "description": "Whether or not the store was connected to WooCommerce.com during the extension flow.", + "required": false, + "type": "boolean" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/profile/experimental_get_email_prefill": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/profile/experimental_get_email_prefill" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks" + } + ] + }, + "endpoints": [ + { + "args": { + "ids": { + "description": "Optional parameter to get only specific task lists by ID.", + "items": { + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "extended_tasks": { + "description": "List of extended deprecated tasks from the client-side filter.", + "required": false, + "type": "array" + }, + "ids": { + "description": "Optional parameter to get only specific task lists by ID.", + "items": { + "enum": [ + "extended", + "secret_tasklist", + "setup" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/(?P[a-z0-9_-]+)/snooze": { + "endpoints": [ + { + "args": { + "duration": { + "description": "Time period to snooze the task.", + "required": false, + "type": "string" + }, + "task_list_id": { + "description": "Optional parameter to query specific task list.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/action": { + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/dismiss": { + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/hide": { + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/undo_dismiss": { + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/undo_snooze": { + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/(?P[a-z0-9_\\-]+)/unhide": { + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/create_homepage": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_homepage" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/create_product_from_template": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/create_product_from_template" + } + ] + }, + "endpoints": [ + { + "args": { + "template_name": { + "description": "Product template name.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/tasks/import_sample_products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/tasks/import_sample_products" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/themes/activate": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/activate" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/themes/install": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/install" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/onboarding/themes/recommended": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/onboarding/themes/recommended" + } + ] + }, + "endpoints": [ + { + "args": { + "currency": { + "default": "USD", + "description": "Returns pricing in this currency (optional, default: USD)", + "enum": [ + "AUD", + "CAD", + "EUR", + "GBP", + "USD" + ], + "required": false, + "type": "string" + }, + "industry": { + "description": "Limits the results to themes relevant for this industry (optional)", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/options": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/options" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/payment-gateway-suggestions": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions" + } + ] + }, + "endpoints": [ + { + "args": { + "force_default_suggestions": { + "description": "Return the default payment suggestions when woocommerce_show_marketplace_suggestions and woocommerce_setting_payments_recommendations_hidden options are set to no", + "required": false, + "type": "boolean" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/payment-gateway-suggestions/dismiss": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/payment-gateway-suggestions/dismiss" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/activate": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/activate/status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/activate/status" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/activate/status/(?P[a-z0-9_\\-]+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/active": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/active" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/connect-jetpack": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-jetpack" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/connect-square": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-square" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/connect-wcpay": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/connect-wcpay" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/finish-wccom-connect": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/finish-wccom-connect" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/install": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/install/status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/install/status" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/install/status/(?P[a-z0-9_\\-]+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/installed": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/installed" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/plugins/request-wccom-connect": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/plugins/request-wccom-connect" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-admin" + }, + "/wc-admin/shipping-partner-suggestions": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/shipping-partner-suggestions" + } + ] + }, + "endpoints": [ + { + "args": { + "force_default_suggestions": { + "description": "Return the default shipping partner suggestions when woocommerce_show_marketplace_suggestions option is set to no", + "required": false, + "type": "boolean" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-admin" + }, + "/wc-admin/themes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-admin/themes" + } + ] + }, + "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" + }, + "pluginzip": { + "description": "A zip file of the theme to be uploaded.", + "required": false, + "type": "file" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-admin" + }, + "/wc-analytics": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc-analytics", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes" + } + ] + }, + "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" + }, + "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", + "note_id", + "status", + "title", + "type" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "source": { + "description": "Source of note.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Status of note.", + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "type": { + "description": "Type of note.", + "items": { + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "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", + "note_id", + "status", + "title", + "type" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "source": { + "description": "Source of note.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Status of note.", + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "type": { + "description": "Type of note.", + "items": { + "enum": [ + "email", + "error", + "info", + "marketing", + "survey", + "update", + "warning" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes/(?P[\\d-]+)": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes/(?P[\\d-]+)/action/(?P[\\d-]+)": { + "endpoints": [ + { + "args": { + "action_id": { + "description": "Unique ID for the Note Action.", + "required": false, + "type": "integer" + }, + "note_id": { + "description": "Unique ID for the Note.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "action_id": { + "description": "Unique ID for the Note Action.", + "required": false, + "type": "integer" + }, + "note_id": { + "description": "Unique ID for the Note.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes/delete/(?P[\\d-]+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "DELETE" + ] + }, + { + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "DELETE" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes/delete/all": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/delete/all" + } + ] + }, + "endpoints": [ + { + "args": { + "status": { + "description": "Status of note.", + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "DELETE" + ] + }, + { + "args": { + "status": { + "description": "Status of note.", + "items": { + "enum": [ + "actioned", + "pending", + "sent", + "snoozed", + "unactioned" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "DELETE" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes/experimental-activate-promo/(?P[\\w-]+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes/tracker/(?P[\\d-]+)/user/(?P[\\d-]+)": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/admin/notes/update": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/admin/notes/update" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/coupons": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "code": { + "description": "Limit result set to resources with a specific code.", + "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" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "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" + }, + "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", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to coupons with codes matching a given string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "default": "fixed_cart", + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "default": false, + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "default": false, + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "default": false, + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "code": { + "description": "Limit result set to resources with a specific code.", + "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" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "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" + }, + "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", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to coupons with codes matching a given string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "default": "fixed_cart", + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "default": false, + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "default": false, + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "default": false, + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/coupons/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "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", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "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/coupons/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/coupons/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/customers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/customers" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "avg_order_value_between": { + "description": "Limit response to objects with an average order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "avg_order_value_max": { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "required": false, + "type": "number" + }, + "avg_order_value_min": { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "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" + }, + "country_excludes": { + "description": "Limit response to objects excluding specific countries.", + "required": false, + "type": "string" + }, + "country_includes": { + "description": "Limit response to objects with specific countries.", + "required": false, + "type": "string" + }, + "email_excludes": { + "description": "Limit response to objects excluding emails.", + "required": false, + "type": "string" + }, + "email_includes": { + "description": "Limit response to objects including emails.", + "required": false, + "type": "string" + }, + "filter_empty": { + "description": "Filter out results where any of the passed fields are empty", + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "include": { + "description": "Limit result to items with specified customer IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "last_active_after": { + "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_before": { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "last_order_after": { + "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_order_before": { + "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "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" + ], + "required": false, + "type": "string" + }, + "name_excludes": { + "description": "Limit response to objects excluding specific names.", + "required": false, + "type": "string" + }, + "name_includes": { + "description": "Limit response to objects with specific names.", + "required": false, + "type": "string" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date_registered", + "description": "Sort collection by object attribute.", + "enum": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ], + "required": false, + "type": "string" + }, + "orders_count_between": { + "description": "Limit response to objects with an order count between two given integers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "orders_count_max": { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "required": false, + "type": "integer" + }, + "orders_count_min": { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "required": false, + "type": "integer" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "registered_after": { + "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_before": { + "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "required": false, + "type": "string" + }, + "searchby": { + "default": "name", + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "enum": [ + "all", + "email", + "name", + "username" + ], + "required": false, + "type": "string" + }, + "total_spend_between": { + "description": "Limit response to objects with a total order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "total_spend_max": { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "required": false, + "type": "number" + }, + "total_spend_min": { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "username_excludes": { + "description": "Limit response to objects excluding specific usernames.", + "required": false, + "type": "string" + }, + "username_includes": { + "description": "Limit response to objects with specific usernames.", + "required": false, + "type": "string" + }, + "users": { + "description": "Limit result to items with specified user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/customers/(?P[\\d-]+)": { + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "avg_order_value_between": { + "description": "Limit response to objects with an average order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "avg_order_value_max": { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "required": false, + "type": "number" + }, + "avg_order_value_min": { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "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" + }, + "country_excludes": { + "description": "Limit response to objects excluding specific countries.", + "required": false, + "type": "string" + }, + "country_includes": { + "description": "Limit response to objects with specific countries.", + "required": false, + "type": "string" + }, + "email_excludes": { + "description": "Limit response to objects excluding emails.", + "required": false, + "type": "string" + }, + "email_includes": { + "description": "Limit response to objects including emails.", + "required": false, + "type": "string" + }, + "filter_empty": { + "description": "Filter out results where any of the passed fields are empty", + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + }, + "include": { + "description": "Limit result to items with specified customer IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "last_active_after": { + "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_before": { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "last_order_after": { + "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_order_before": { + "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "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" + ], + "required": false, + "type": "string" + }, + "name_excludes": { + "description": "Limit response to objects excluding specific names.", + "required": false, + "type": "string" + }, + "name_includes": { + "description": "Limit response to objects with specific names.", + "required": false, + "type": "string" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date_registered", + "description": "Sort collection by object attribute.", + "enum": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ], + "required": false, + "type": "string" + }, + "orders_count_between": { + "description": "Limit response to objects with an order count between two given integers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "orders_count_max": { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "required": false, + "type": "integer" + }, + "orders_count_min": { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "required": false, + "type": "integer" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "registered_after": { + "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_before": { + "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "required": false, + "type": "string" + }, + "searchby": { + "default": "name", + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "enum": [ + "all", + "email", + "name", + "username" + ], + "required": false, + "type": "string" + }, + "total_spend_between": { + "description": "Limit response to objects with a total order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "total_spend_max": { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "required": false, + "type": "number" + }, + "total_spend_min": { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "username_excludes": { + "description": "Limit response to objects excluding specific usernames.", + "required": false, + "type": "string" + }, + "username_includes": { + "description": "Limit response to objects with specific usernames.", + "required": false, + "type": "string" + }, + "users": { + "description": "Limit result to items with specified user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/data": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/data/countries": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/data/countries/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "location": { + "description": "ISO3166 alpha-2 country code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "location": { + "description": "ISO3166 alpha-2 country code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/data/countries/locales": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/countries/locales" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/data/download-ips": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/data/download-ips" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/leaderboards": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 5, + "description": "Maximum number of items to be returned in result set.", + "maximum": 20, + "minimum": 1, + "required": false, + "type": "integer" + }, + "persisted_query": { + "description": "URL query to persist across links.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/leaderboards/(?P\\w+)": { + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "leaderboard": { + "enum": [ + "categories", + "coupons", + "customers", + "products" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 5, + "description": "Maximum number of items to be returned in result set.", + "maximum": 20, + "minimum": 1, + "required": false, + "type": "integer" + }, + "persisted_query": { + "description": "URL query to persist across links.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/leaderboards/allowed": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/leaderboards/allowed" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/orders": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "customer": { + "description": "Limit result set to orders assigned a specific customer.", + "required": false, + "type": "integer" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "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" + }, + "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" + }, + "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" + }, + "number": { + "description": "Limit result set to orders matching part of an order number.", + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_item_display_meta": { + "default": false, + "description": "Only show meta which is meant to be displayed for an order.", + "required": false, + "type": "boolean" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "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": { + "description": "Limit result set to orders assigned a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": [ + "any" + ], + "description": "Limit result set to orders which have specific statuses.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "default": "EUR", + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "default": 0, + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "default": false, + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "default": false, + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "default": "pending", + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "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" + }, + "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" + }, + "customer": { + "description": "Limit result set to orders assigned a specific customer.", + "required": false, + "type": "integer" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "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" + }, + "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" + }, + "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" + }, + "number": { + "description": "Limit result set to orders matching part of an order number.", + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_item_display_meta": { + "default": false, + "description": "Only show meta which is meant to be displayed for an order.", + "required": false, + "type": "boolean" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "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": { + "description": "Limit result set to orders assigned a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": [ + "any" + ], + "description": "Limit result set to orders which have specific statuses.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "default": "EUR", + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "default": 0, + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "default": false, + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "default": false, + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "default": "pending", + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/orders/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "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", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "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/orders/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/orders/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "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" + }, + "low_in_stock": { + "default": false, + "description": "Limit result set to products that are low or out of stock. (Deprecated)", + "required": false, + "type": "boolean" + }, + "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", + "popularity", + "popularity", + "popularity", + "price", + "rating", + "rating", + "rating", + "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" + }, + "search": { + "description": "Search by similar product name or SKU.", + "required": false, + "type": "string" + }, + "search_sku": { + "description": "Limit results to those with a SKU that partially matches a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "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" + }, + "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": { + "default": "no", + "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": { + "default": "visible", + "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": { + "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 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": { + "default": false, + "description": "Featured product.", + "required": false, + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "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": { + "default": false, + "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": { + "default": true, + "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": { + "default": false, + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, + "status": { + "default": "publish", + "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": { + "default": "instock", + "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": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "simple", + "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": { + "default": false, + "description": "If the product is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Product 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" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "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" + }, + "low_in_stock": { + "default": false, + "description": "Limit result set to products that are low or out of stock. (Deprecated)", + "required": false, + "type": "boolean" + }, + "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", + "popularity", + "popularity", + "popularity", + "price", + "rating", + "rating", + "rating", + "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" + }, + "search": { + "description": "Search by similar product name or SKU.", + "required": false, + "type": "string" + }, + "search_sku": { + "description": "Limit results to those with a SKU that partially matches a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "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" + }, + "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": { + "default": "no", + "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": { + "default": "visible", + "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": { + "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 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": { + "default": false, + "description": "Featured product.", + "required": false, + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "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": { + "default": false, + "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": { + "default": true, + "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": { + "default": false, + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, + "status": { + "default": "publish", + "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": { + "default": "instock", + "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": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "simple", + "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": { + "default": false, + "description": "If the product is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/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": { + "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": [ + "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" + }, + "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": [ + "POST" + ] + } + ], + "methods": [ + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/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": { + "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" + }, + "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": { + "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" + }, + "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": { + "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" + }, + "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": { + "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" + }, + "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" + ] + } + ], + "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": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes" + } + ] + }, + "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" + }, + "search": { + "description": "Search by similar attribute name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "default": false, + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "default": "menu_order", + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "default": "select", + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "search": { + "description": "Search by similar attribute name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "default": false, + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "default": "menu_order", + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "default": "select", + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/attributes/(?P[\\d]+)/terms": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "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/attributes/(?P[\\d]+)/terms/batch": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "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", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "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/attributes/(?P[a-z0-9_\\-]+)": { + "endpoints": [ + { + "args": { + "slug": { + "description": "Slug identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "slug": { + "description": "Slug identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/attributes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/attributes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/batch" + } + ] + }, + "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" + }, + "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" + }, + "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": { + "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" + }, + "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" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "default": "default", + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "default": "default", + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "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", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "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/categories/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/categories/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/count-low-in-stock": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/count-low-in-stock" + } + ] + }, + "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" + }, + "status": { + "default": "publish", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/low-in-stock": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/low-in-stock" + } + ] + }, + "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" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "status": { + "default": "publish", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "status": { + "default": "publish", + "description": "Limit result set to products assigned a specific status.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/reviews": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to reviews 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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date_gmt", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": [], + "description": "Limit result set to reviews assigned to specific product IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "reviewer": { + "description": "Limit result set to reviews assigned to specific user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "reviewer_email": { + "default": null, + "description": "Limit result set to that from a specific author email.", + "format": "email", + "required": false, + "type": "string" + }, + "reviewer_exclude": { + "description": "Ensure result set excludes reviews assigned to specific user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "approved", + "description": "Limit result set to reviews assigned a specific status.", + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "product_id": { + "description": "Unique identifier for the product.", + "required": true, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "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": { + "default": "approved", + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "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" + }, + "before": { + "description": "Limit response to reviews 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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date_gmt", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": [], + "description": "Limit result set to reviews assigned to specific product IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "reviewer": { + "description": "Limit result set to reviews assigned to specific user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "reviewer_email": { + "default": null, + "description": "Limit result set to that from a specific author email.", + "format": "email", + "required": false, + "type": "string" + }, + "reviewer_exclude": { + "description": "Ensure result set excludes reviews assigned to specific user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "approved", + "description": "Limit result set to reviews assigned a specific status.", + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "product_id": { + "description": "Unique identifier for the product.", + "required": true, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "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": { + "default": "approved", + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the product that the review belongs to.", + "required": false, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "required": false, + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "format": "email", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "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", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the product that the review belongs to.", + "required": false, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "required": false, + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "format": "email", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "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/reviews/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/reviews/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "product_id": { + "description": "Unique identifier for the product that the review belongs to.", + "required": false, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "required": false, + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "format": "email", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "product_id": { + "description": "Unique identifier for the product that the review belongs to.", + "required": false, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "required": false, + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "format": "email", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/products/suggested-products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/products/suggested-products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "categories": { + "default": [], + "description": "Limit result set to specific product categorie ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "in_stock": { + "description": "Limit result set to products in stock or out of stock.", + "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" + }, + "limit": { + "default": 5, + "description": "Limit result set to specific amount of suggested products.", + "required": false, + "type": "integer" + }, + "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", + "popularity", + "popularity", + "rating", + "rating", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "tags": { + "default": [], + "description": "Limit result set to specific product tag ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "categories": { + "default": [], + "description": "Limit result set to specific product categorie ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "in_stock": { + "description": "Limit result set to products in stock or out of stock.", + "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" + }, + "limit": { + "default": 5, + "description": "Limit result set to specific amount of suggested products.", + "required": false, + "type": "integer" + }, + "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", + "popularity", + "popularity", + "rating", + "rating", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "tags": { + "default": [], + "description": "Limit result set to specific product tag ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/(?P[a-z]+)/export": { + "endpoints": [ + { + "args": { + "email": { + "description": "When true, email a link to download the export to the requesting user.", + "required": false, + "type": "boolean" + }, + "report_args": { + "description": "Parameters to pass on to the exported report.", + "required": false, + "type": "object" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/(?P[a-z]+)/export/(?P[a-z0-9]+)/status": { + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/categories" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "categories": { + "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "extended_info": { + "default": false, + "description": "Add additional piece of info about each category to the report.", + "required": false, + "type": "boolean" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], + "required": false, + "type": "string" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "category_id", + "description": "Sort collection by object attribute.", + "enum": [ + "category", + "category_id", + "items_sold", + "net_revenue", + "orders_count", + "products_count" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "status_is": { + "description": "Limit result set to items that have the specified order status.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "status_is_not": { + "description": "Limit result set to items that don't have the specified order status.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/coupons": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "coupons": { + "description": "Limit result set to coupons assigned specific coupon IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "extended_info": { + "default": false, + "description": "Add additional piece of info about each coupon to the report.", + "required": false, + "type": "boolean" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "coupon_id", + "description": "Sort collection by object attribute.", + "enum": [ + "amount", + "code", + "coupon_id", + "orders_count" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/coupons/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/coupons/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "coupons": { + "description": "Limit result set to coupons assigned specific coupon IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "fields": { + "description": "Limit stats fields to the specified items.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], + "required": false, + "type": "string" + }, + "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": [ + "amount", + "coupons_count", + "date", + "orders_count" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "segmentby": { + "description": "Segment the response by additional constraint.", + "enum": [ + "category", + "coupon", + "product", + "variation" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/customers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "avg_order_value_between": { + "description": "Limit response to objects with an average order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "avg_order_value_max": { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "required": false, + "type": "number" + }, + "avg_order_value_min": { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "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" + }, + "country_excludes": { + "description": "Limit response to objects excluding specific countries.", + "required": false, + "type": "string" + }, + "country_includes": { + "description": "Limit response to objects with specific countries.", + "required": false, + "type": "string" + }, + "customers": { + "description": "Limit result to items with specified customer IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "email_excludes": { + "description": "Limit response to objects excluding emails.", + "required": false, + "type": "string" + }, + "email_includes": { + "description": "Limit response to objects including emails.", + "required": false, + "type": "string" + }, + "filter_empty": { + "description": "Filter out results where any of the passed fields are empty", + "items": { + "enum": [ + "city", + "country", + "email", + "name", + "postcode", + "state" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "last_active_after": { + "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_before": { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "last_order_after": { + "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_order_before": { + "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "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" + ], + "required": false, + "type": "string" + }, + "name_excludes": { + "description": "Limit response to objects excluding specific names.", + "required": false, + "type": "string" + }, + "name_includes": { + "description": "Limit response to objects with specific names.", + "required": false, + "type": "string" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date_registered", + "description": "Sort collection by object attribute.", + "enum": [ + "avg_order_value", + "city", + "country", + "date_last_active", + "date_registered", + "name", + "orders_count", + "postcode", + "state", + "total_spend", + "username" + ], + "required": false, + "type": "string" + }, + "orders_count_between": { + "description": "Limit response to objects with an order count between two given integers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "orders_count_max": { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "required": false, + "type": "integer" + }, + "orders_count_min": { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "required": false, + "type": "integer" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "registered_after": { + "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_before": { + "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "required": false, + "type": "string" + }, + "searchby": { + "default": "name", + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "enum": [ + "all", + "email", + "name", + "username" + ], + "required": false, + "type": "string" + }, + "total_spend_between": { + "description": "Limit response to objects with a total order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "total_spend_max": { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "required": false, + "type": "number" + }, + "total_spend_min": { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "username_excludes": { + "description": "Limit response to objects excluding specific usernames.", + "required": false, + "type": "string" + }, + "username_includes": { + "description": "Limit response to objects with specific usernames.", + "required": false, + "type": "string" + }, + "users": { + "description": "Limit result to items with specified user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/customers/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/customers/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "avg_order_value_between": { + "description": "Limit response to objects with an average order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "avg_order_value_max": { + "description": "Limit response to objects with an average order spend less than or equal to a given number.", + "required": false, + "type": "number" + }, + "avg_order_value_min": { + "description": "Limit response to objects with an average order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "country_excludes": { + "description": "Limit response to objects excluding specific countries.", + "required": false, + "type": "string" + }, + "country_includes": { + "description": "Limit response to objects with specific countries.", + "required": false, + "type": "string" + }, + "customers": { + "description": "Limit result to items with specified customer IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "email_excludes": { + "description": "Limit response to objects excluding emails.", + "required": false, + "type": "string" + }, + "email_includes": { + "description": "Limit response to objects including emails.", + "required": false, + "type": "string" + }, + "fields": { + "description": "Limit stats fields to the specified items.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "last_active_after": { + "description": "Limit response to objects last active after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_before": { + "description": "Limit response to objects last active before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_active_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "last_order_after": { + "description": "Limit response to objects with last order after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "last_order_before": { + "description": "Limit response to objects with last order before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "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" + ], + "required": false, + "type": "string" + }, + "name_excludes": { + "description": "Limit response to objects excluding specific names.", + "required": false, + "type": "string" + }, + "name_includes": { + "description": "Limit response to objects with specific names.", + "required": false, + "type": "string" + }, + "orders_count_between": { + "description": "Limit response to objects with an order count between two given integers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "orders_count_max": { + "description": "Limit response to objects with an order count less than or equal to given integer.", + "required": false, + "type": "integer" + }, + "orders_count_min": { + "description": "Limit response to objects with an order count greater than or equal to given integer.", + "required": false, + "type": "integer" + }, + "registered_after": { + "description": "Limit response to objects registered after (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_before": { + "description": "Limit response to objects registered before (or at) a given ISO8601 compliant datetime.", + "format": "date-time", + "required": false, + "type": "string" + }, + "registered_between": { + "description": "Limit response to objects last active between two given ISO8601 compliant datetime.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit response to objects with a customer field containing the search term. Searches the field provided by 'searchby'.", + "required": false, + "type": "string" + }, + "searchby": { + "default": "name", + "description": "Limit results with `search` and `searchby` to specific fields containing the search term.", + "enum": [ + "all", + "email", + "name", + "username" + ], + "required": false, + "type": "string" + }, + "total_spend_between": { + "description": "Limit response to objects with a total order spend between two given numbers.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "total_spend_max": { + "description": "Limit response to objects with a total order spend less than or equal to given number.", + "required": false, + "type": "number" + }, + "total_spend_min": { + "description": "Limit response to objects with a total order spend greater than or equal to given number.", + "required": false, + "type": "number" + }, + "username_excludes": { + "description": "Limit response to objects excluding specific usernames.", + "required": false, + "type": "string" + }, + "username_includes": { + "description": "Limit response to objects with specific usernames.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/downloads": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "customer_excludes": { + "description": "Limit response to objects that don't have the specified user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "customer_includes": { + "description": "Limit response to objects that have the specified user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "ip_address_excludes": { + "description": "Limit response to objects that don't have a specified IP address.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "ip_address_includes": { + "description": "Limit response to objects that have a specified IP address.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "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" + ], + "required": false, + "type": "string" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_excludes": { + "description": "Limit result set to items that don't have the specified order IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order_includes": { + "description": "Limit result set to items that have the specified order IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "product" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_includes": { + "default": [], + "description": "Limit result set to items that have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/downloads/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/downloads/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "customer_excludes": { + "description": "Limit response to objects that don't have the specified customer IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "customer_includes": { + "description": "Limit response to objects that have the specified customer IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "fields": { + "description": "Limit stats fields to the specified items.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], + "required": false, + "type": "string" + }, + "ip_address_excludes": { + "description": "Limit response to objects that don't have a specified IP address.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "ip_address_includes": { + "description": "Limit response to objects that have a specified IP address.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "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" + ], + "required": false, + "type": "string" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_excludes": { + "description": "Limit result set to items that don't have the specified order IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order_includes": { + "description": "Limit result set to items that have the specified order IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "download_count" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_includes": { + "default": [], + "description": "Limit result set to items that have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/import": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import" + } + ] + }, + "endpoints": [ + { + "args": { + "days": { + "description": "Number of days to import.", + "minimum": 0, + "required": false, + "type": "integer" + }, + "skip_existing": { + "default": false, + "description": "Skip importing existing order data.", + "required": false, + "type": "boolean" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/import/cancel": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/cancel" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/import/delete": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/delete" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/import/status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/status" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/import/totals": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/import/totals" + } + ] + }, + "endpoints": [ + { + "args": { + "days": { + "description": "Number of days to import.", + "minimum": 0, + "required": false, + "type": "integer" + }, + "skip_existing": { + "default": false, + "description": "Skip importing existing order data.", + "required": false, + "type": "boolean" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/orders": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_is": { + "default": [], + "description": "Limit result set to orders that include products with the specified attributes.", + "items": { + "type": "array" + }, + "required": false, + "type": "array" + }, + "attribute_is_not": { + "default": [], + "description": "Limit result set to orders that don't include products with the specified attributes.", + "items": { + "type": "array" + }, + "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" + }, + "coupon_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified coupon(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "coupon_includes": { + "default": [], + "description": "Limit result set to items that have the specified coupon(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "customer_type": { + "default": "", + "description": "Limit result set to returning or new customers.", + "enum": [ + "", + "new", + "returning" + ], + "required": false, + "type": "string" + }, + "extended_info": { + "default": false, + "description": "Add additional piece of info about each coupon to the report.", + "required": false, + "type": "boolean" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_excludes": { + "description": "Limit result set to items that don't have the specified order IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order_includes": { + "description": "Limit result set to items that have the specified order IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "net_total", + "num_items_sold" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "product_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_includes": { + "default": [], + "description": "Limit result set to items that have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "refunds": { + "default": "", + "description": "Limit result set to specific types of refunds.", + "enum": [ + "", + "all", + "full", + "none", + "partial" + ], + "required": false, + "type": "string" + }, + "status_is": { + "description": "Limit result set to items that have the specified order status.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "status_is_not": { + "description": "Limit result set to items that don't have the specified order status.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "tax_rate_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "tax_rate_includes": { + "default": [], + "description": "Limit result set to items that have the specified tax rate(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "variation_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified variation(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "variation_includes": { + "default": [], + "description": "Limit result set to items that have the specified variation(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/orders/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/orders/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_is": { + "default": [], + "description": "Limit result set to orders that include products with the specified attributes.", + "items": { + "type": "array" + }, + "required": false, + "type": "array" + }, + "attribute_is_not": { + "default": [], + "description": "Limit result set to orders that don't include products with the specified attributes.", + "items": { + "type": "array" + }, + "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" + }, + "coupon_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified coupon(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "coupon_includes": { + "default": [], + "description": "Limit result set to items that have the specified coupon(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "customer": { + "description": "Alias for customer_type (deprecated).", + "enum": [ + "new", + "returning" + ], + "required": false, + "type": "string" + }, + "customer_type": { + "description": "Limit result set to orders that have the specified customer_type", + "enum": [ + "new", + "returning" + ], + "required": false, + "type": "string" + }, + "fields": { + "description": "Limit stats fields to the specified items.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "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" + ], + "required": false, + "type": "string" + }, + "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": [ + "avg_order_value", + "date", + "net_revenue", + "orders_count" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_includes": { + "default": [], + "description": "Limit result set to items that have the specified product(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "refunds": { + "default": "", + "description": "Limit result set to specific types of refunds.", + "enum": [ + "", + "all", + "full", + "none", + "partial" + ], + "required": false, + "type": "string" + }, + "segmentby": { + "description": "Segment the response by additional constraint.", + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ], + "required": false, + "type": "string" + }, + "status_is": { + "default": null, + "description": "Limit result set to items that have the specified order status.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "status_is_not": { + "description": "Limit result set to items that don't have the specified order status.", + "items": { + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "tax_rate_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified tax rate(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "tax_rate_includes": { + "default": [], + "description": "Limit result set to items that have the specified tax rate(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "variation_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified variation(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "variation_includes": { + "default": [], + "description": "Limit result set to items that have the specified variation(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/performance-indicators": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "stats": { + "default": [ + "coupons/amount", + "coupons/orders_count", + "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", + "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": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/performance-indicators/allowed": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/performance-indicators/allowed" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "stats": { + "default": [ + "coupons/amount", + "coupons/orders_count", + "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", + "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": [ + "coupons/amount", + "coupons/orders_count", + "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", + "taxes/total_tax", + "variations/items_sold" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "categories": { + "description": "Limit result to items from the specified categories.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "extended_info": { + "default": false, + "description": "Add additional piece of info about each product to the report.", + "required": false, + "type": "boolean" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "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" + ], + "required": false, + "type": "string" + }, + "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", + "items_sold", + "net_revenue", + "orders_count", + "product_name", + "sku", + "variations" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "products": { + "description": "Limit result to items with specified product IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/products/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/products/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "categories": { + "description": "Limit result to items from the specified categories.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "fields": { + "description": "Limit stats fields to the specified items.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], + "required": false, + "type": "string" + }, + "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": [ + "coupons", + "date", + "items_sold", + "net_revenue", + "net_revenue", + "orders_count", + "refunds", + "shipping", + "taxes" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "products": { + "description": "Limit result to items with specified product IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "segmentby": { + "description": "Segment the response by additional constraint.", + "enum": [ + "category", + "product", + "variation" + ], + "required": false, + "type": "string" + }, + "variations": { + "description": "Limit result to items with specified variation IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/revenue/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/revenue/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "date_type": { + "description": "Override the \"woocommerce_date_type\" option that is used for the database date field considered for revenue reports.", + "enum": [ + "date_completed", + "date_created", + "date_paid" + ], + "required": false, + "type": "string" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], + "required": false, + "type": "string" + }, + "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": [ + "coupons", + "date", + "gross_sales", + "items_sold", + "net_revenue", + "orders_count", + "refunds", + "shipping", + "taxes", + "total_sales" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "segmentby": { + "description": "Segment the response by additional constraint.", + "enum": [ + "category", + "coupon", + "customer_type", + "product", + "variation" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/stock": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "stock_status", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "sku", + "stock_quantity", + "stock_status", + "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" + }, + "type": { + "default": "all", + "description": "Limit result set to items assigned a stock report type.", + "enum": [ + "all", + "instock", + "lowstock", + "onbackorder", + "outofstock" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/stock/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/stock/stats" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/taxes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "tax_rate_id", + "description": "Sort collection by object attribute.", + "enum": [ + "name", + "order_tax", + "orders_count", + "rate", + "shipping_tax", + "tax_code", + "tax_rate_id", + "total_tax" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "taxes": { + "description": "Limit result set to items assigned one or more tax rates.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/taxes/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/taxes/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "fields": { + "description": "Limit stats fields to the specified items.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "enum": [ + "day", + "hour", + "month", + "quarter", + "week", + "year" + ], + "required": false, + "type": "string" + }, + "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", + "items_sold", + "orders_count", + "products_count", + "total_sales" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "segmentby": { + "description": "Segment the response by additional constraint.", + "enum": [ + "tax_rate_id" + ], + "required": false, + "type": "string" + }, + "taxes": { + "description": "Limit result set to all items that have the specified term assigned in the taxes taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/variations": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_is": { + "default": [], + "description": "Limit result set to variations that include the specified attributes.", + "items": { + "type": "array" + }, + "required": false, + "type": "array" + }, + "attribute_is_not": { + "default": [], + "description": "Limit result set to variations that don't include the specified attributes.", + "items": { + "type": "array" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category_excludes": { + "description": "Limit result set to variations not in the specified categories.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "category_includes": { + "description": "Limit result set to variations in the specified categories.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "extended_info": { + "default": false, + "description": "Add additional piece of info about each variation to the report.", + "required": false, + "type": "boolean" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "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" + ], + "required": false, + "type": "string" + }, + "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", + "items_sold", + "net_revenue", + "orders_count", + "sku" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified parent product(s).", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_includes": { + "default": [], + "description": "Limit result set to items that have the specified parent product(s).", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "products": { + "description": "Limit result to items with specified product IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "variations": { + "description": "Limit result to items with specified variation IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/reports/variations/stats": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/reports/variations/stats" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_is": { + "default": [], + "description": "Limit result set to orders that include products with the specified attributes.", + "items": { + "type": "array" + }, + "required": false, + "type": "array" + }, + "attribute_is_not": { + "default": [], + "description": "Limit result set to orders that don't include products with the specified attributes.", + "items": { + "type": "array" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category_excludes": { + "description": "Limit result set to variations not in the specified categories.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "category_includes": { + "description": "Limit result to items from the specified categories.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "fields": { + "description": "Limit stats fields to the specified items.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "force_cache_refresh": { + "description": "Force retrieval of fresh data instead of from the cache.", + "required": false, + "type": "boolean" + }, + "interval": { + "default": "week", + "description": "Time interval to use for buckets in the returned data.", + "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" + ], + "required": false, + "type": "string" + }, + "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": [ + "coupons", + "date", + "items_sold", + "net_revenue", + "net_revenue", + "orders_count", + "refunds", + "shipping", + "taxes" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_excludes": { + "default": [], + "description": "Limit result set to items that don't have the specified parent product(s).", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_includes": { + "default": [], + "description": "Limit result set to items that have the specified parent product(s).", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "segmentby": { + "description": "Segment the response by additional constraint.", + "enum": [ + "category", + "product", + "variation" + ], + "required": false, + "type": "string" + }, + "variations": { + "description": "Limit result to items with specified variation IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/settings/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/settings/(?P[\\w-]+)/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "GET", + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/settings/(?P[\\w-]+)/batch": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/taxes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes" + } + ] + }, + "endpoints": [ + { + "args": { + "class": { + "description": "Sort by tax class.", + "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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "include": { + "default": [], + "description": "Limit result set to items that have the specified rate ID(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "order", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "order", + "priority" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Search by similar tax code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "default": "standard", + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "default": false, + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "default": 1, + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "default": true, + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "class": { + "description": "Sort by tax class.", + "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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "include": { + "default": [], + "description": "Limit result set to items that have the specified rate ID(s) assigned.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "order", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "order", + "priority" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Search by similar tax code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "default": "standard", + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "default": false, + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "default": 1, + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "default": true, + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "GET", + "POST", + "POST" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/taxes/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "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", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "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/taxes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/taxes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "PATCH", + "POST", + "POST", + "PUT", + "PUT" + ], + "namespace": "wc-analytics" + }, + "/wc-analytics/variations": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-analytics/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" + }, + "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": { + "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" + }, + "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": { + "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" + }, + "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": { + "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" + }, + "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" + ] + } + ], + "methods": [ + "GET", + "GET", + "GET", + "GET" + ], + "namespace": "wc-analytics" + }, + "/wc-telemetry": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc-telemetry", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc-telemetry" + }, + "/wc-telemetry/tracker": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc-telemetry/tracker" + } + ] + }, + "endpoints": [ + { + "args": { + "installation_date": { + "description": "Installation date of the WooCommerce mobile app.", + "format": "date-time", + "required": false, + "type": "string" + }, + "platform": { + "description": "Platform to track.", + "required": true, + "type": "string" + }, + "version": { + "description": "Platform version to track.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc-telemetry" + }, + "/wc/private": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc/private", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/private" + }, + "/wc/private/ai/business-description": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/business-description" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "business_description": { + "description": "The business description for a given store.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/private" + }, + "/wc/private/ai/images": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/images" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "business_description": { + "description": "The business description for a given store.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/private" + }, + "/wc/private/ai/patterns": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/patterns" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "business_description": { + "description": "The business description for a given store.", + "required": false, + "type": "string" + }, + "images": { + "description": "The images for a given store.", + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "POST" + ], + "namespace": "wc/private" + }, + "/wc/private/ai/product": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/product" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "last_product": { + "description": "Whether the product being updated is the last one in the loop", + "required": false, + "type": "boolean" + }, + "products_information": { + "description": "Data generated by AI for updating dummy products.", + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/private" + }, + "/wc/private/ai/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/products" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "business_description": { + "description": "The business description for a given store.", + "required": false, + "type": "string" + }, + "images": { + "description": "The images for a given store.", + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "POST" + ], + "namespace": "wc/private" + }, + "/wc/private/ai/store-info": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-info" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/private" + }, + "/wc/private/ai/store-title": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/ai/store-title" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "business_description": { + "description": "The business description for a given store.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/private" + }, + "/wc/private/patterns": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/private/patterns" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/private" + }, + "/wc/store": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc/store", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "requests": { + "items": { + "properties": { + "body": { + "additionalProperties": true, + "properties": [], + "type": "object" + }, + "headers": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": [ + "array", + "string" + ] + }, + "properties": [], + "type": "object" + }, + "method": { + "default": "POST", + "enum": [ + "DELETE", + "PATCH", + "POST", + "PUT" + ], + "type": "string" + }, + "path": { + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "maxItems": 25, + "required": true, + "type": "array" + }, + "validation": { + "default": "normal", + "enum": [ + "normal", + "require-all-validate" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/add-item": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/add-item" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "id": { + "description": "The basket item product or variation ID.", + "required": false, + "type": "integer" + }, + "quantity": { + "description": "Quantity of this item to add to the basket.", + "required": false, + "type": "integer" + }, + "variation": { + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/apply-coupon": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/apply-coupon" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/coupons": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/coupons" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "The coupon's unique code.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/coupons/(?P[\\w-]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/extensions": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/extensions" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "data": { + "description": "Additional data to pass to the extension", + "required": false, + "type": "object" + }, + "namespace": { + "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/items": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/items" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "extensions": { + "default": [], + "properties": [], + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/items/(?P[\\w-]{32})": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "key": { + "description": "Unique identifier for the item within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "extensions": { + "properties": [], + "required": false, + "type": "object" + }, + "key": { + "description": "Unique identifier for the item within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "key": { + "description": "Unique identifier for the item within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/remove-coupon": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-coupon" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/remove-item": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/remove-item" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "key": { + "description": "Unique identifier (key) for the basket item.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/select-shipping-rate": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/select-shipping-rate" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "package_id": { + "description": "The ID of the package being shipped. Leave blank to apply to all packages.", + "required": false, + "type": [ + "integer", + "null", + "string" + ] + }, + "rate_id": { + "description": "The chosen rate ID for the package.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/update-customer": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-customer" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "billing_address": { + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/cart/update-item": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/cart/update-item" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "key": { + "description": "Unique identifier (key) for the basket item to update.", + "required": false, + "type": "string" + }, + "quantity": { + "description": "New quantity of the item in the basket.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/checkout": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/checkout" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "create_account": { + "description": "Whether to create a new user account as part of order processing.", + "required": false, + "type": "boolean" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "required": false, + "type": "string" + }, + "customer_password": { + "description": "Customer password for new accounts, if applicable.", + "required": false, + "type": "string" + }, + "extensions": { + "default": { + "woocommerce/order-attribution": [] + }, + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "required": false, + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": [ + "boolean", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "required": false, + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/checkout/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "required": false, + "type": "string" + }, + "extensions": { + "default": { + "woocommerce/order-attribution": [] + }, + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "required": false, + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": [ + "boolean", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "required": false, + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store" + }, + "/wc/store/order/(?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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_relation": { + "default": "and", + "description": "The logical relationship between attributes when filtering across several at once.", + "enum": [ + "and", + "in" + ], + "required": false, + "type": "string" + }, + "attributes": { + "default": [], + "description": "Limit result set to products with selected global attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources created before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "catalog_visibility": { + "description": "Determines if hidden or visible catalogue products are shown.", + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "category_operator": { + "default": "in", + "description": "Operator to compare product category terms.", + "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": [ + "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" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "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. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "rating": { + "default": [], + "description": "Limit result set to products with a certain average rating.", + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "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 specific slug(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "stock_status": { + "default": [], + "description": "Limit result set to products with specified stock status.", + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "required": false, + "type": "array" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "tag_operator": { + "default": "in", + "description": "Operator to compare product tags.", + "enum": [ + "and", + "in", + "not_in" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/(?P[\\S]+)": { + "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" + }, + "slug": { + "description": "Slug of the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/attributes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/attributes" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/attributes/(?P[\\d]+)/terms": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute.", + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": true, + "description": "If true, empty terms will not be returned.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order": { + "default": "asc", + "description": "Sort ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort by term property.", + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/categories" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": true, + "description": "If true, empty terms will not be returned.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order": { + "default": "asc", + "description": "Sort ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort by term property.", + "enum": [ + "count", + "name", + "slug" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/collection-data": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/collection-data" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_relation": { + "default": "and", + "description": "The logical relationship between attributes when filtering across several at once.", + "enum": [ + "and", + "in" + ], + "required": false, + "type": "string" + }, + "attributes": { + "default": [], + "description": "Limit result set to products with selected global attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources created before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "calculate_attribute_counts": { + "default": [], + "description": "If requested, calculates attribute term counts for products in the collection.", + "items": { + "properties": { + "query_type": { + "context": [ + "edit", + "view" + ], + "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", + "enum": [ + "and", + "or" + ], + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomy name.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "calculate_price_range": { + "default": false, + "description": "If true, calculates the minimum and maximum product prices for the collection.", + "required": false, + "type": "boolean" + }, + "calculate_rating_counts": { + "default": false, + "description": "If true, calculates rating counts for products in the collection.", + "required": false, + "type": "boolean" + }, + "calculate_stock_status_counts": { + "default": false, + "description": "If true, calculates stock counts for products in the collection.", + "required": false, + "type": "boolean" + }, + "catalog_visibility": { + "description": "Determines if hidden or visible catalogue products are shown.", + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "category_operator": { + "default": "in", + "description": "Operator to compare product category terms.", + "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": [ + "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" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "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. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "rating": { + "default": [], + "description": "Limit result set to products with a certain average rating.", + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "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 specific slug(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "stock_status": { + "default": [], + "description": "Limit result set to products with specified stock status.", + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "required": false, + "type": "array" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "tag_operator": { + "default": "in", + "description": "Operator to compare product tags.", + "enum": [ + "and", + "in", + "not_in" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/reviews": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/reviews" + } + ] + }, + "endpoints": [ + { + "args": { + "category_id": { + "description": "Limit result set to reviews from specific category IDs.", + "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" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "date_gmt", + "id", + "product", + "rating" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Limit result set to reviews from specific product IDs.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/products/tags": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/products/tags" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": true, + "description": "If true, empty terms will not be returned.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order": { + "default": "asc", + "description": "Sort ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort by term property.", + "enum": [ + "count", + "name", + "slug" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store" + }, + "/wc/store/v1": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc/store/v1", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "requests": { + "items": { + "properties": { + "body": { + "additionalProperties": true, + "properties": [], + "type": "object" + }, + "headers": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": [ + "array", + "string" + ] + }, + "properties": [], + "type": "object" + }, + "method": { + "default": "POST", + "enum": [ + "DELETE", + "PATCH", + "POST", + "PUT" + ], + "type": "string" + }, + "path": { + "required": true, + "type": "string" + } + }, + "type": "object" + }, + "maxItems": 25, + "required": true, + "type": "array" + }, + "validation": { + "default": "normal", + "enum": [ + "normal", + "require-all-validate" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/add-item": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/add-item" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "id": { + "description": "The basket item product or variation ID.", + "required": false, + "type": "integer" + }, + "quantity": { + "description": "Quantity of this item to add to the basket.", + "required": false, + "type": "integer" + }, + "variation": { + "description": "Chosen attributes (for variations).", + "items": { + "properties": { + "attribute": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute name.", + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Variation attribute value.", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/apply-coupon": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/apply-coupon" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/coupons": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/coupons" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "The coupon's unique code.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "The discount type for the coupon (eg percentage or fixed amount)", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/coupons/(?P[\\w-]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/extensions": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/extensions" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "data": { + "description": "Additional data to pass to the extension", + "required": false, + "type": "object" + }, + "namespace": { + "description": "Extension's name - this will be used to ensure the data in the request is routed appropriately.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/items": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/items" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "extensions": { + "default": [], + "properties": [], + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/items/(?P[\\w-]{32})": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "key": { + "description": "Unique identifier for the item within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "extensions": { + "properties": [], + "required": false, + "type": "object" + }, + "key": { + "description": "Unique identifier for the item within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "key": { + "description": "Unique identifier for the item within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/remove-coupon": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-coupon" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "code": { + "description": "Unique identifier for the coupon within the basket.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/remove-item": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/remove-item" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "key": { + "description": "Unique identifier (key) for the basket item.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/select-shipping-rate": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/select-shipping-rate" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "package_id": { + "description": "The ID of the package being shipped. Leave blank to apply to all packages.", + "required": false, + "type": [ + "integer", + "null", + "string" + ] + }, + "rate_id": { + "description": "The chosen rate ID for the package.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/update-customer": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-customer" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "billing_address": { + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_address": { + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/cart/update-item": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/cart/update-item" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "key": { + "description": "Unique identifier (key) for the basket item to update.", + "required": false, + "type": "string" + }, + "quantity": { + "description": "New quantity of the item in the basket.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/checkout": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/checkout" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "create_account": { + "description": "Whether to create a new user account as part of order processing.", + "required": false, + "type": "boolean" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "required": false, + "type": "string" + }, + "customer_password": { + "description": "Customer password for new accounts, if applicable.", + "required": false, + "type": "string" + }, + "extensions": { + "default": { + "woocommerce/order-attribution": [] + }, + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "required": false, + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": [ + "boolean", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "required": false, + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/checkout/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "additional_fields": { + "description": "Additional fields to be persisted on the order.", + "properties": [], + "required": false, + "type": "object" + }, + "billing_address": { + "description": "Billing address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": true, + "type": "object" + }, + "customer_note": { + "description": "Note added to the order by the customer during checkout.", + "required": false, + "type": "string" + }, + "extensions": { + "default": { + "woocommerce/order-attribution": [] + }, + "properties": { + "woocommerce/order-attribution": { + "context": [ + "edit", + "view" + ], + "description": "Extension data registered by woocommerce/order-attribution", + "properties": { + "referrer": { + "context": [], + "description": "Order attribution field: referrer", + "type": [ + "null", + "string" + ] + }, + "session_count": { + "context": [], + "description": "Order attribution field: session_count", + "type": [ + "null", + "string" + ] + }, + "session_entry": { + "context": [], + "description": "Order attribution field: session_entry", + "type": [ + "null", + "string" + ] + }, + "session_pages": { + "context": [], + "description": "Order attribution field: session_pages", + "type": [ + "null", + "string" + ] + }, + "session_start_time": { + "context": [], + "description": "Order attribution field: session_start_time", + "type": [ + "null", + "string" + ] + }, + "source_type": { + "context": [], + "description": "Order attribution field: source_type", + "type": [ + "null", + "string" + ] + }, + "user_agent": { + "context": [], + "description": "Order attribution field: user_agent", + "type": [ + "null", + "string" + ] + }, + "utm_campaign": { + "context": [], + "description": "Order attribution field: utm_campaign", + "type": [ + "null", + "string" + ] + }, + "utm_content": { + "context": [], + "description": "Order attribution field: utm_content", + "type": [ + "null", + "string" + ] + }, + "utm_creative_format": { + "context": [], + "description": "Order attribution field: utm_creative_format", + "type": [ + "null", + "string" + ] + }, + "utm_id": { + "context": [], + "description": "Order attribution field: utm_id", + "type": [ + "null", + "string" + ] + }, + "utm_marketing_tactic": { + "context": [], + "description": "Order attribution field: utm_marketing_tactic", + "type": [ + "null", + "string" + ] + }, + "utm_medium": { + "context": [], + "description": "Order attribution field: utm_medium", + "type": [ + "null", + "string" + ] + }, + "utm_source": { + "context": [], + "description": "Order attribution field: utm_source", + "type": [ + "null", + "string" + ] + }, + "utm_source_platform": { + "context": [], + "description": "Order attribution field: utm_source_platform", + "type": [ + "null", + "string" + ] + }, + "utm_term": { + "context": [], + "description": "Order attribution field: utm_term", + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "required": false, + "type": "object" + }, + "payment_data": { + "description": "Data to pass through to the payment method when processing payment.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": [ + "boolean", + "string" + ] + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "payment_method": { + "description": "The ID of the payment method being used to process the payment.", + "enum": [ + "bacs", + "cheque", + "cod" + ], + "required": false, + "type": "string" + }, + "shipping_address": { + "description": "Shipping address.", + "properties": { + "address_1": { + "context": [ + "edit", + "view" + ], + "description": "Address", + "required": true, + "type": "string" + }, + "address_2": { + "context": [ + "edit", + "view" + ], + "description": "Flat, suite, etc.", + "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": [ + "edit", + "view" + ], + "description": "Country/Region code in ISO 3166-1 alpha-2 format.", + "required": true, + "type": "string" + }, + "first_name": { + "context": [ + "edit", + "view" + ], + "description": "First name", + "required": true, + "type": "string" + }, + "last_name": { + "context": [ + "edit", + "view" + ], + "description": "Last name", + "required": true, + "type": "string" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone", + "required": true, + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postcode", + "required": true, + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "State/County code, or name of the state, county, province, or district.", + "required": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/store/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_relation": { + "default": "and", + "description": "The logical relationship between attributes when filtering across several at once.", + "enum": [ + "and", + "in" + ], + "required": false, + "type": "string" + }, + "attributes": { + "default": [], + "description": "Limit result set to products with selected global attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources created before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "catalog_visibility": { + "description": "Determines if hidden or visible catalogue products are shown.", + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "category_operator": { + "default": "in", + "description": "Operator to compare product category terms.", + "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": [ + "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" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "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. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "rating": { + "default": [], + "description": "Limit result set to products with a certain average rating.", + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "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 specific slug(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "stock_status": { + "default": [], + "description": "Limit result set to products with specified stock status.", + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "required": false, + "type": "array" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "tag_operator": { + "default": "in", + "description": "Operator to compare product tags.", + "enum": [ + "and", + "in", + "not_in" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "Slug of the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/products/attributes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/attributes" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/products/attributes/(?P[\\d]+)/terms": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute.", + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": true, + "description": "If true, empty terms will not be returned.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order": { + "default": "asc", + "description": "Sort ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort by term property.", + "enum": [ + "count", + "id", + "menu_order", + "name", + "name_num", + "slug" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/products/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/categories" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": true, + "description": "If true, empty terms will not be returned.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order": { + "default": "asc", + "description": "Sort ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort by term property.", + "enum": [ + "count", + "name", + "slug" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/products/collection-data": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/collection-data" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources created after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute_relation": { + "default": "and", + "description": "The logical relationship between attributes when filtering across several at once.", + "enum": [ + "and", + "in" + ], + "required": false, + "type": "string" + }, + "attributes": { + "default": [], + "description": "Limit result set to products with selected global attributes.", + "items": { + "properties": { + "attribute": { + "description": "Attribute taxonomy name.", + "sanitize_callback": "wc_sanitize_taxonomy_name", + "type": "string" + }, + "operator": { + "description": "Operator to compare product attribute terms.", + "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" + }, + "sanitize_callback": "wp_parse_slug_list", + "type": "array" + }, + "term_id": { + "description": "List of attribute term IDs.", + "items": { + "type": "integer" + }, + "sanitize_callback": "wp_parse_id_list", + "type": "array" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to resources created before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "calculate_attribute_counts": { + "default": [], + "description": "If requested, calculates attribute term counts for products in the collection.", + "items": { + "properties": { + "query_type": { + "context": [ + "edit", + "view" + ], + "description": "Filter condition\t being performed which may affect counts. Valid values include \"and\" and \"or\".", + "enum": [ + "and", + "or" + ], + "readonly": true, + "type": "string" + }, + "taxonomy": { + "context": [ + "edit", + "view" + ], + "description": "Taxonomy name.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "calculate_price_range": { + "default": false, + "description": "If true, calculates the minimum and maximum product prices for the collection.", + "required": false, + "type": "boolean" + }, + "calculate_rating_counts": { + "default": false, + "description": "If true, calculates rating counts for products in the collection.", + "required": false, + "type": "boolean" + }, + "calculate_stock_status_counts": { + "default": false, + "description": "If true, calculates stock counts for products in the collection.", + "required": false, + "type": "boolean" + }, + "catalog_visibility": { + "description": "Determines if hidden or visible catalogue products are shown.", + "enum": [ + "any", + "catalog", + "hidden", + "search", + "visible" + ], + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "required": false, + "type": "string" + }, + "category_operator": { + "default": "in", + "description": "Operator to compare product category terms.", + "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": [ + "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" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "max_price": { + "description": "Limit result set to products based on a maximum price, provided using the smallest unit of the currency.", + "required": false, + "type": "string" + }, + "min_price": { + "description": "Limit result set to products based on a minimum price, provided using the smallest unit of the currency.", + "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": [ + "comment_count", + "date", + "id", + "include", + "menu_order", + "modified", + "popularity", + "price", + "rating", + "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. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "rating": { + "default": [], + "description": "Limit result set to products with a certain average rating.", + "items": { + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "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 specific slug(s). Use commas to separate.", + "required": false, + "type": "string" + }, + "stock_status": { + "default": [], + "description": "Limit result set to products with specified stock status.", + "items": { + "enum": [ + "instock", + "onbackorder", + "outofstock" + ], + "sanitize_callback": "sanitize_text_field", + "type": "string", + "validate_callback": "rest_validate_request_arg" + }, + "required": false, + "type": "array" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "tag_operator": { + "default": "in", + "description": "Operator to compare product tags.", + "enum": [ + "and", + "in", + "not_in" + ], + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable", + "variation" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/products/reviews": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/reviews" + } + ] + }, + "endpoints": [ + { + "args": { + "category_id": { + "description": "Limit result set to reviews from specific category IDs.", + "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" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "date_gmt", + "id", + "product", + "rating" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Limit result set to reviews from specific product IDs.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/store/v1/products/tags": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/store/v1/products/tags" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": true, + "description": "If true, empty terms will not be returned.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order": { + "default": "asc", + "description": "Sort ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort by term property.", + "enum": [ + "count", + "name", + "slug" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set. Defaults to no limit if left blank.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/store/v1" + }, + "/wc/v1": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc/v1", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/coupons": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "code": { + "description": "Limit result set to resources with a specific code.", + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "filter": { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "required": false, + "type": "object" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "default": "fixed_cart", + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "default": false, + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "free_shipping": { + "default": false, + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "default": false, + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/coupons/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/coupons/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/coupons/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "expiry_date": { + "description": "UTC DateTime when the coupon expires.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/customers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers" + } + ] + }, + "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" + }, + "email": { + "description": "Limit result set to resources with a specific email.", + "format": "email", + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "include", + "name", + "registered_date" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "role": { + "default": "customer", + "description": "Limit result set to resources with a specific role.", + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ], + "required": false, + "type": "string" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/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" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/customers/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "password": { + "description": "Customer password.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "Customer login name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "reassign": { + "default": 0, + "description": "ID to reassign posts to.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/customers/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/customers/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "password": { + "description": "Customer password.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "Customer login name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/orders": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "customer": { + "description": "Limit result set to orders assigned a specific customer.", + "required": false, + "type": "integer" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "filter": { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "required": false, + "type": "object" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "description": "Limit result set to orders assigned a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to orders assigned a specific status.", + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "default": "EUR", + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "default": 0, + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Line item meta data.", + "items": { + "properties": { + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Meta label.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "readonly": true, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "readonly": true, + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "default": false, + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "default": "pending", + "description": "Order status.", + "enum": [ + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/orders/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Line item meta data.", + "items": { + "properties": { + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Meta label.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "readonly": true, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "readonly": true, + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "customer_note": { + "default": false, + "description": "Shows/define if the note is only for reference or for the customer (the user will be notified).", + "required": false, + "type": "boolean" + }, + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/orders/(?P[\\d]+)/refunds": { + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "customer": { + "description": "Limit result set to orders assigned a specific customer.", + "required": false, + "type": "integer" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "filter": { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "required": false, + "type": "object" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "description": "Limit result set to orders assigned a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to orders assigned a specific status.", + "enum": [ + "any", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "Refund amount.", + "required": false, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "reason": { + "description": "Reason for refund.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/orders/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/orders/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta": { + "context": [ + "edit", + "view" + ], + "description": "Line item meta data.", + "items": { + "properties": { + "key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "Meta label.", + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value.", + "readonly": true, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "readonly": true, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "string" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "readonly": true, + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "filter": { + "description": "Use WP Query arguments to modify the response; private query vars require appropriate authorisation.", + "required": false, + "type": "object" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "required": false, + "type": "string" + }, + "sku": { + "description": "Limit result set to products with a specific SKU.", + "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" + ], + "required": false, + "type": "string" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "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" + }, + "options": { + "context": [ + "edit", + "view" + ], + "description": "List of available term names of the attribute.", + "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": { + "default": "no", + "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": { + "default": "visible", + "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_on_sale_from": { + "description": "Start date of sale price.", + "required": false, + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "required": false, + "type": "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": { + "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" + }, + "download_type": { + "default": "standard", + "description": "Download type, this controls the schema on the front-end.", + "enum": [ + "standard" + ], + "required": false, + "type": "string" + }, + "downloadable": { + "default": false, + "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": { + "default": false, + "description": "Featured product.", + "required": false, + "type": "boolean" + }, + "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "in_stock": { + "default": true, + "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", + "required": false, + "type": "boolean" + }, + "manage_stock": { + "default": false, + "description": "Stock management at product level.", + "required": false, + "type": "boolean" + }, + "menu_order": { + "description": "Menu order, used to custom sort products.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "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": { + "default": true, + "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": "Unique identifier.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Product slug.", + "required": false, + "type": "string" + }, + "sold_individually": { + "default": false, + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, + "status": { + "default": "publish", + "description": "Product status (post status).", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "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": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "simple", + "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" + }, + "variations": { + "description": "List of variations.", + "items": { + "properties": { + "attributes": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "backordered": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on back-order.", + "readonly": true, + "type": "boolean" + }, + "backorders": { + "context": [ + "edit", + "view" + ], + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "type": "string" + }, + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "Shows if back-orders are allowed.", + "readonly": true, + "type": "boolean" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "context": [ + "edit", + "view" + ], + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "context": [ + "edit", + "view" + ], + "description": "End data of sale price.", + "type": "string" + }, + "dimensions": { + "context": [ + "edit", + "view" + ], + "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" + } + }, + "type": "object" + }, + "download_expiry": { + "context": [ + "edit", + "view" + ], + "default": null, + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "context": [ + "edit", + "view" + ], + "default": null, + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "downloadable": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "in_stock": { + "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": [ + "edit", + "view" + ], + "default": false, + "description": "Stock management at variation level.", + "type": "boolean" + }, + "on_sale": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on sale.", + "readonly": true, + "type": "boolean" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Variation URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current variation price.", + "readonly": true, + "type": "string" + }, + "purchasable": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation can be bought.", + "readonly": true, + "type": "boolean" + }, + "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": [ + "edit", + "view" + ], + "description": "Shipping class ID.", + "readonly": true, + "type": "integer" + }, + "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": [ + "edit", + "view" + ], + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "type": "string" + }, + "virtual": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is virtual.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "description": "If the variation is visible.", + "type": "boolean" + }, + "weight": { + "context": [ + "edit", + "view" + ], + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "virtual": { + "default": false, + "description": "If the product is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/(?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 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.", + "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_on_sale_from": { + "description": "Start date of sale price.", + "required": false, + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "required": false, + "type": "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" + }, + "download_type": { + "description": "Download type, this controls the schema on the front-end.", + "enum": [ + "standard" + ], + "required": false, + "type": "string" + }, + "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" + }, + "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "in_stock": { + "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", + "required": false, + "type": "boolean" + }, + "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" + }, + "name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "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": "Unique identifier.", + "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", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "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" + }, + "variations": { + "description": "List of variations.", + "items": { + "properties": { + "attributes": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "backordered": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on back-order.", + "readonly": true, + "type": "boolean" + }, + "backorders": { + "context": [ + "edit", + "view" + ], + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "type": "string" + }, + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "Shows if back-orders are allowed.", + "readonly": true, + "type": "boolean" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "context": [ + "edit", + "view" + ], + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "context": [ + "edit", + "view" + ], + "description": "End data of sale price.", + "type": "string" + }, + "dimensions": { + "context": [ + "edit", + "view" + ], + "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" + } + }, + "type": "object" + }, + "download_expiry": { + "context": [ + "edit", + "view" + ], + "default": null, + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "context": [ + "edit", + "view" + ], + "default": null, + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "downloadable": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "in_stock": { + "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": [ + "edit", + "view" + ], + "default": false, + "description": "Stock management at variation level.", + "type": "boolean" + }, + "on_sale": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on sale.", + "readonly": true, + "type": "boolean" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Variation URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current variation price.", + "readonly": true, + "type": "string" + }, + "purchasable": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation can be bought.", + "readonly": true, + "type": "boolean" + }, + "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": [ + "edit", + "view" + ], + "description": "Shipping class ID.", + "readonly": true, + "type": "integer" + }, + "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": [ + "edit", + "view" + ], + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "type": "string" + }, + "virtual": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is virtual.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "description": "If the variation is visible.", + "type": "boolean" + }, + "weight": { + "context": [ + "edit", + "view" + ], + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + }, + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/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": [ + "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": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "email": { + "description": "Reviewer email.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "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" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/attributes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "default": false, + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "default": "menu_order", + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "default": "select", + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/attributes/(?P[\\d]+)/terms": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/attributes/(?P[\\d]+)/terms/batch": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/attributes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/attributes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/batch" + } + ] + }, + "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" + }, + "options": { + "context": [ + "edit", + "view" + ], + "description": "List of available term names of the attribute.", + "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_on_sale_from": { + "description": "Start date of sale price.", + "required": false, + "type": "string" + }, + "date_on_sale_to": { + "description": "End data of sale price.", + "required": false, + "type": "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" + }, + "download_type": { + "description": "Download type, this controls the schema on the front-end.", + "enum": [ + "standard" + ], + "required": false, + "type": "string" + }, + "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" + }, + "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "in_stock": { + "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", + "required": false, + "type": "boolean" + }, + "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" + }, + "name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "parent_id": { + "description": "Product parent ID.", + "required": false, + "type": "integer" + }, + "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": "Unique identifier.", + "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", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "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" + }, + "variations": { + "description": "List of variations.", + "items": { + "properties": { + "attributes": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "backordered": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on back-order.", + "readonly": true, + "type": "boolean" + }, + "backorders": { + "context": [ + "edit", + "view" + ], + "default": "no", + "description": "If managing stock, this controls if back-orders are allowed.", + "enum": [ + "no", + "notify", + "yes" + ], + "type": "string" + }, + "backorders_allowed": { + "context": [ + "edit", + "view" + ], + "description": "Shows if back-orders are allowed.", + "readonly": true, + "type": "boolean" + }, + "date_created": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was created, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the variation was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "date_on_sale_from": { + "context": [ + "edit", + "view" + ], + "description": "Start date of sale price.", + "type": "string" + }, + "date_on_sale_to": { + "context": [ + "edit", + "view" + ], + "description": "End data of sale price.", + "type": "string" + }, + "dimensions": { + "context": [ + "edit", + "view" + ], + "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" + } + }, + "type": "object" + }, + "download_expiry": { + "context": [ + "edit", + "view" + ], + "default": null, + "description": "Number of days until access to downloadable files expires.", + "type": "integer" + }, + "download_limit": { + "context": [ + "edit", + "view" + ], + "default": null, + "description": "Number of times downloadable files can be downloaded after purchase.", + "type": "integer" + }, + "downloadable": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is downloadable.", + "type": "boolean" + }, + "downloads": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "in_stock": { + "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": [ + "edit", + "view" + ], + "default": false, + "description": "Stock management at variation level.", + "type": "boolean" + }, + "on_sale": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation is on sale.", + "readonly": true, + "type": "boolean" + }, + "permalink": { + "context": [ + "edit", + "view" + ], + "description": "Variation URL.", + "format": "uri", + "readonly": true, + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Current variation price.", + "readonly": true, + "type": "string" + }, + "purchasable": { + "context": [ + "edit", + "view" + ], + "description": "Shows if the variation can be bought.", + "readonly": true, + "type": "boolean" + }, + "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": [ + "edit", + "view" + ], + "description": "Shipping class ID.", + "readonly": true, + "type": "integer" + }, + "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": [ + "edit", + "view" + ], + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "type": "string" + }, + "virtual": { + "context": [ + "edit", + "view" + ], + "default": false, + "description": "If the variation is virtual.", + "type": "boolean" + }, + "visible": { + "context": [ + "edit", + "view" + ], + "description": "If the variation is visible.", + "type": "boolean" + }, + "weight": { + "context": [ + "edit", + "view" + ], + "description": "Variation weight (kg).", + "type": "string" + } + }, + "type": "object" + }, + "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" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "default": "default", + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "image": { + "description": "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/categories/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/categories/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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_modified": { + "context": [ + "edit", + "view" + ], + "description": "The date the image was last modified, in the site's timezone.", + "readonly": true, + "type": [ + "null", + "string" + ] + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/shipping_classes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Shipping class name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/shipping_classes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/shipping_classes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/tags": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tag name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/products/tags/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/products/tags/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tag name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/reports": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/reports/sales": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/sales" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "date_max": { + "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "date_min": { + "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "period": { + "description": "Report period.", + "enum": [ + "last_month", + "month", + "week", + "year" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/reports/top_sellers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/reports/top_sellers" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "date_max": { + "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "date_min": { + "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "period": { + "description": "Report period.", + "enum": [ + "last_month", + "month", + "week", + "year" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/taxes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes" + } + ] + }, + "endpoints": [ + { + "args": { + "class": { + "description": "Sort by tax class.", + "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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "order", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "order", + "priority" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "city": { + "description": "City name.", + "required": false, + "type": "string" + }, + "class": { + "default": "standard", + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "default": false, + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "required": false, + "type": "string" + }, + "priority": { + "default": 1, + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "default": true, + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/taxes/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "city": { + "description": "City name.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "required": false, + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/taxes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "city": { + "description": "City name.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "required": false, + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v1/taxes/classes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/taxes/classes" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/taxes/classes/(?P\\w[\\w\\s\\-]*)": { + "endpoints": [ + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "slug": { + "description": "Unique slug for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE" + ], + "namespace": "wc/v1" + }, + "/wc/v1/webhooks": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "all", + "description": "Limit result set to webhooks assigned a specific status.", + "enum": [ + "active", + "all", + "disabled", + "paused" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "default": "active", + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v1" + }, + "/wc/v1/webhooks/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "webhook_id": { + "description": "Unique identifier for the webhook.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v1" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "webhook_id": { + "description": "Unique identifier for the webhook.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v1" + }, + "/wc/v1/webhooks/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v1/webhooks/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v1" + }, + "/wc/v2": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc/v2", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/coupons": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "code": { + "description": "Limit result set to resources with a specific code.", + "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" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "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" + }, + "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", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "default": "fixed_cart", + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "default": false, + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "default": false, + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "default": false, + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/coupons/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/coupons/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/coupons/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/customers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers" + } + ] + }, + "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" + }, + "email": { + "description": "Limit result set to resources with a specific email.", + "format": "email", + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "include", + "name", + "registered_date" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "role": { + "default": "customer", + "description": "Limit result set to resources with a specific role.", + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ], + "required": false, + "type": "string" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "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" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/customers/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "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" + }, + "password": { + "description": "Customer password.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "Customer login name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "reassign": { + "default": 0, + "description": "ID to reassign posts to.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/customers/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/customers/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "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" + }, + "password": { + "description": "Customer password.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "Customer login name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/orders": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "customer": { + "description": "Limit result set to orders assigned a specific customer.", + "required": false, + "type": "integer" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "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" + }, + "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" + }, + "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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_item_display_meta": { + "default": false, + "description": "Only show meta which is meant to be displayed for an order.", + "required": false, + "type": "boolean" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "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": { + "description": "Limit result set to orders assigned a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to orders assigned a specific status.", + "enum": [ + "any", + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "default": "EUR", + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "default": 0, + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "default": false, + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "default": "pending", + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/orders/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "type": { + "default": "any", + "description": "Limit result to customers or internal notes.", + "enum": [ + "any", + "customer", + "internal" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "customer_note": { + "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.", + "required": false, + "type": "boolean" + }, + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/orders/(?P[\\d]+)/refunds": { + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "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" + }, + "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" + }, + "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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "order_item_display_meta": { + "default": false, + "description": "Only show meta which is meant to be displayed for an order.", + "required": false, + "type": "boolean" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "Refund amount.", + "required": false, + "type": "string" + }, + "api_refund": { + "default": true, + "description": "When true, the payment gateway API is used to generate the refund.", + "required": false, + "type": "boolean" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "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" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "reason": { + "description": "Reason for refund.", + "required": false, + "type": "string" + }, + "refunded_by": { + "description": "User ID of user who created the refund.", + "required": false, + "type": "integer" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/orders/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/orders/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/payment_gateways": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/payment_gateways" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "Payment gateway description on checkout.", + "required": false, + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + }, + "order": { + "description": "Payment gateway sort order.", + "required": false, + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "in_stock": { + "description": "Limit result set to products in stock or out of stock.", + "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", + "popularity", + "popularity", + "rating", + "rating", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "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" + }, + "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": { + "default": "no", + "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": { + "default": "visible", + "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_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, as GMT.", + "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": { + "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 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": { + "default": false, + "description": "Featured product.", + "required": false, + "type": "boolean" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "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" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "in_stock": { + "default": true, + "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", + "required": false, + "type": "boolean" + }, + "manage_stock": { + "default": false, + "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" + }, + "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": { + "default": true, + "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": "Unique identifier.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Product slug.", + "required": false, + "type": "string" + }, + "sold_individually": { + "default": false, + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, + "status": { + "default": "publish", + "description": "Product status (post status).", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "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": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "simple", + "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": { + "default": false, + "description": "If the product is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/(?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 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_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, as GMT.", + "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" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "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" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "in_stock": { + "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", + "required": false, + "type": "boolean" + }, + "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" + }, + "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": "Unique identifier.", + "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", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/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": [ + "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": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "email": { + "description": "Email of the reviewer.", + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the variation.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name of the reviewer.", + "required": true, + "type": "string" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "Review content.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "date_created": { + "description": "The date the review was created, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "email": { + "description": "Reviewer email.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "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" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/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" + ] + }, + "date_created_gmt": { + "description": "The date the review was created, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "email": { + "description": "Reviewer email.", + "required": false, + "type": "string" + }, + "name": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "product_id": { + "description": "Unique identifier for the variable product.", + "required": false, + "type": "integer" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/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" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "in_stock": { + "description": "Limit result set to products in stock or out of stock.", + "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": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "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, as GMT.", + "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" + }, + "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" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "in_stock": { + "default": true, + "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", + "required": false, + "type": "boolean" + }, + "manage_stock": { + "default": false, + "description": "Stock management at variation level.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "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" + }, + "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": "Unique identifier.", + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "virtual": { + "default": false, + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "visible": { + "default": true, + "description": "Define if the variation is visible on the product's page.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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": [ + "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, as GMT.", + "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" + }, + "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" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "in_stock": { + "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", + "required": false, + "type": "boolean" + }, + "manage_stock": { + "description": "Stock management at variation level.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "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" + }, + "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": "Unique identifier.", + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/(?P[\\d]+)/variations/batch": { + "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": { + "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, as GMT.", + "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" + }, + "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" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "in_stock": { + "description": "Controls whether or not the variation is listed as \"in stock\" or \"out of stock\" on the front-end.", + "required": false, + "type": "boolean" + }, + "manage_stock": { + "description": "Stock management at variation level.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "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" + }, + "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": "Unique identifier.", + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "tax_class": { + "description": "Tax class.", + "required": false, + "type": "string" + }, + "tax_status": { + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "virtual": { + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "visible": { + "description": "Define if the variation is visible on the product's page.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/attributes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "default": false, + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "default": "menu_order", + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "default": "select", + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/attributes/(?P[\\d]+)/terms": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/attributes/(?P[\\d]+)/terms/batch": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/attributes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/attributes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/batch" + } + ] + }, + "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" + }, + "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_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, as GMT.", + "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" + }, + "grouped_products": { + "description": "List of grouped products ID.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "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" + }, + "position": { + "context": [ + "edit", + "view" + ], + "description": "Image position. 0 means that the image is featured.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "in_stock": { + "description": "Controls whether or not the product is listed as \"in stock\" or \"out of stock\" on the frontend.", + "required": false, + "type": "boolean" + }, + "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" + }, + "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": "Unique identifier.", + "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", + "future", + "pending", + "private", + "publish" + ], + "required": false, + "type": "string" + }, + "stock_quantity": { + "description": "Stock quantity.", + "required": false, + "type": "integer" + }, + "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" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "default": "default", + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "image": { + "description": "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" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/categories/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/categories/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + }, + "title": { + "context": [ + "edit", + "view" + ], + "description": "Image name.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/shipping_classes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Shipping class name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/shipping_classes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/shipping_classes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/tags": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tag name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/products/tags/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/products/tags/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tag name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/reports": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/reports/sales": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/sales" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "date_max": { + "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "date_min": { + "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "period": { + "description": "Report period.", + "enum": [ + "last_month", + "month", + "week", + "year" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/reports/top_sellers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/reports/top_sellers" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "date_max": { + "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "date_min": { + "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "period": { + "description": "Report period.", + "enum": [ + "last_month", + "month", + "week", + "year" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/settings": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/settings" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/settings/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/settings/(?P[\\w-]+)/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/settings/(?P[\\w-]+)/batch": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/shipping/zones": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping/zones" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": { + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/shipping/zones/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Shipping zone name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/shipping/zones/(?P[\\d]+)/locations": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "code": { + "description": "Shipping zone location code.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + }, + "type": { + "description": "Shipping zone location type.", + "enum": [ + "continent", + "country", + "postcode", + "state" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/shipping/zones/(?P[\\d]+)/methods": { + "endpoints": [ + { + "args": { + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "enabled": { + "description": "Shipping method enabled status.", + "required": false, + "type": "boolean" + }, + "method_id": { + "description": "Shipping method ID.", + "required": true + }, + "order": { + "description": "Shipping method sort order.", + "required": false, + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/shipping/zones/(?P[\\d]+)/methods/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "instance_id": { + "description": "Unique ID for the instance.", + "required": false, + "type": "integer" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "enabled": { + "description": "Shipping method enabled status.", + "required": false, + "type": "boolean" + }, + "instance_id": { + "description": "Unique ID for the instance.", + "required": false, + "type": "integer" + }, + "order": { + "description": "Shipping method sort order.", + "required": false, + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "instance_id": { + "description": "Unique ID for the instance.", + "required": false, + "type": "integer" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/shipping_methods": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/shipping_methods" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/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" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/system_status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/system_status/tools": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/system_status/tools" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/system_status/tools/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "action": { + "description": "What running the tool will do.", + "required": false, + "type": "string" + }, + "description": { + "description": "Tool description.", + "required": false, + "type": "string" + }, + "id": { + "description": "A unique identifier for the tool.", + "required": false, + "type": "string" + }, + "message": { + "description": "Tool return message.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tool name.", + "required": false, + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "required": false, + "type": "boolean" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/taxes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes" + } + ] + }, + "endpoints": [ + { + "args": { + "class": { + "description": "Sort by tax class.", + "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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "order", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "order", + "priority" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "city": { + "description": "City name.", + "required": false, + "type": "string" + }, + "class": { + "default": "standard", + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "default": false, + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "required": false, + "type": "string" + }, + "priority": { + "default": 1, + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "default": true, + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/taxes/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "city": { + "description": "City name.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "required": false, + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/taxes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "city": { + "description": "City name.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode / ZIP.", + "required": false, + "type": "string" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v2/taxes/classes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/taxes/classes" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/taxes/classes/(?P\\w[\\w\\s\\-]*)": { + "endpoints": [ + { + "args": { + "slug": { + "description": "Unique slug for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "slug": { + "description": "Unique slug for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/webhooks": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "all", + "description": "Limit result set to webhooks assigned a specific status.", + "enum": [ + "active", + "all", + "disabled", + "paused" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "default": "active", + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v2" + }, + "/wc/v2/webhooks/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "webhook_id": { + "description": "Unique identifier for the webhook.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "webhook_id": { + "description": "Unique identifier for the webhook.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v2" + }, + "/wc/v2/webhooks/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v2/webhooks/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v2" + }, + "/wc/v3": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wc/v3", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/coupons": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "code": { + "description": "Limit result set to resources with a specific code.", + "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" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "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" + }, + "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", + "modified", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": true, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "default": "fixed_cart", + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "default": false, + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "default": false, + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "default": false, + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/coupons/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/coupons/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/coupons/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "amount": { + "description": "The amount of discount. Should always be numeric, even if setting a percentage.", + "required": false, + "type": "string" + }, + "code": { + "description": "Coupon code.", + "required": false, + "type": "string" + }, + "date_expires": { + "description": "The date the coupon expires, in the site's timezone.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_expires_gmt": { + "description": "The date the coupon expires, as GMT.", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "Coupon description.", + "required": false, + "type": "string" + }, + "discount_type": { + "description": "Determines the type of discount that will be applied.", + "enum": [ + "fixed_cart", + "fixed_product", + "percent" + ], + "required": false, + "type": "string" + }, + "email_restrictions": { + "description": "List of email addresses that can use this coupon.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "exclude_sale_items": { + "description": "If true, this coupon will not be applied to items that have sale prices.", + "required": false, + "type": "boolean" + }, + "excluded_product_categories": { + "description": "List of category IDs the coupon does not apply to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "excluded_product_ids": { + "description": "List of product IDs the coupon cannot be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "free_shipping": { + "description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.", + "required": false, + "type": "boolean" + }, + "individual_use": { + "description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.", + "required": false, + "type": "boolean" + }, + "limit_usage_to_x_items": { + "description": "Max number of items in the basket the coupon can be applied to.", + "required": false, + "type": "integer" + }, + "maximum_amount": { + "description": "Maximum order amount allowed when using the coupon.", + "required": false, + "type": "string" + }, + "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" + }, + "minimum_amount": { + "description": "Minimum order amount that needs to be in the basket before coupon applies.", + "required": false, + "type": "string" + }, + "product_categories": { + "description": "List of category IDs the coupon applies to.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_ids": { + "description": "List of product IDs the coupon can be used on.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "The status of the coupon. Should always be draft, published, or pending review", + "required": false, + "type": "string" + }, + "usage_limit": { + "description": "How many times the coupon can be used in total.", + "required": false, + "type": "integer" + }, + "usage_limit_per_user": { + "description": "How many times the coupon can be used per customer.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/customers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers" + } + ] + }, + "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" + }, + "email": { + "description": "Limit result set to resources with a specific email.", + "format": "email", + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "include", + "name", + "registered_date" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "role": { + "default": "customer", + "description": "Limit result set to resources with a specific role.", + "enum": [ + "administrator", + "all", + "author", + "contributor", + "customer", + "editor", + "shop_manager", + "subscriber" + ], + "required": false, + "type": "string" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "New user email address.", + "required": true, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "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" + }, + "password": { + "description": "New user password.", + "required": true, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone number.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "New user username.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/customers/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "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" + }, + "password": { + "description": "Customer password.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone number.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "Customer login name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "reassign": { + "default": 0, + "description": "ID to reassign posts to.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/customers/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/customers/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "billing": { + "description": "List of billing address data.", + "properties": { + "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": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "email": { + "description": "The email address for the customer.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "Customer first name.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Customer last name.", + "required": false, + "type": "string" + }, + "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" + }, + "password": { + "description": "Customer password.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "List of shipping address data.", + "properties": { + "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" + }, + "phone": { + "context": [ + "edit", + "view" + ], + "description": "Phone number.", + "type": "string" + }, + "postcode": { + "context": [ + "edit", + "view" + ], + "description": "Postal code.", + "type": "string" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "username": { + "description": "Customer login name.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data/continents": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/continents" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data/continents/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "continent": { + "description": "2 character continent code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data/countries": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/countries" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data/countries/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "location": { + "description": "ISO3166 alpha-2 country code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data/currencies": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data/currencies/(?P[\\w-]{3})": { + "endpoints": [ + { + "args": { + "location": { + "description": "ISO4217 currency code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/data/currencies/current": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/data/currencies/current" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/layout-templates": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/layout-templates" + } + ] + }, + "endpoints": [ + { + "args": { + "area": { + "default": "", + "description": "Area to get templates for.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/layout-templates/(?P\\w[\\w\\s\\-]*)": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/create-order": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/create-order" + } + ] + }, + "endpoints": [ + { + "args": { + "product_id": { + "required": true + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/featured": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/featured" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/refresh": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/refresh" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/subscriptions": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/subscriptions/activate": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/activate" + } + ] + }, + "endpoints": [ + { + "args": { + "product_key": { + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/subscriptions/connect": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/connect" + } + ] + }, + "endpoints": [ + { + "args": { + "product_key": { + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/subscriptions/disconnect": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/disconnect" + } + ] + }, + "endpoints": [ + { + "args": { + "product_key": { + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/marketplace/subscriptions/install-url": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/marketplace/subscriptions/install-url" + } + ] + }, + "endpoints": [ + { + "args": { + "product_key": { + "required": true, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/orders": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "customer": { + "description": "Limit result set to orders assigned a specific customer.", + "required": false, + "type": "integer" + }, + "dates_are_gmt": { + "default": false, + "description": "Whether to consider GMT post dates when limiting response by published or modified date.", + "required": false, + "type": "boolean" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "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" + }, + "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" + }, + "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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_item_display_meta": { + "default": false, + "description": "Only show meta which is meant to be displayed for an order.", + "required": false, + "type": "boolean" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "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": { + "description": "Limit result set to orders assigned a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "any", + "description": "Limit result set to orders which have specific statuses.", + "items": { + "enum": [ + "any", + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded", + "trash" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "default": "EUR", + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "default": 0, + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "default": false, + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "default": false, + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "default": "pending", + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/orders/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/orders/(?P[\\d]+)/receipt": { + "endpoints": [ + { + "args": { + "expiration_date": { + "default": null, + "description": "Expiration date formatted as dd-mm-yyyy.", + "required": false, + "type": "string" + }, + "expiration_days": { + "default": 1, + "description": "Number of days to be added to the current date to get the expiration date.", + "required": false, + "type": "integer" + }, + "force_new": { + "default": false, + "description": "True to force the creation of a new receipt even if one already exists and has not expired yet.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier of the order.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": { + "id": { + "description": "Unique identifier of the order.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "type": { + "default": "any", + "description": "Limit result to customers or internal notes.", + "enum": [ + "any", + "customer", + "internal" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "added_by_user": { + "default": false, + "description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.", + "required": false, + "type": "boolean" + }, + "customer_note": { + "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.", + "required": false, + "type": "boolean" + }, + "note": { + "description": "Order note content.", + "required": true, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/orders/(?P[\\d]+)/refunds": { + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "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" + }, + "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" + }, + "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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "order_item_display_meta": { + "default": false, + "description": "Only show meta which is meant to be displayed for an order.", + "required": false, + "type": "boolean" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "amount": { + "description": "Refund amount.", + "required": false, + "type": "string" + }, + "api_refund": { + "default": true, + "description": "When true, the payment gateway API is used to generate the refund.", + "required": false, + "type": "boolean" + }, + "api_restock": { + "default": true, + "description": "When true, refunded items are restocked.", + "required": false, + "type": "boolean" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "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" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + }, + "reason": { + "description": "Reason for refund.", + "required": false, + "type": "string" + }, + "refunded_by": { + "description": "User ID of user who created the refund.", + "required": false, + "type": "integer" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "order_id": { + "description": "The order ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/orders/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/orders/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "billing": { + "description": "Billing address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "email": { + "context": [ + "edit", + "view" + ], + "description": "Email address.", + "format": "email", + "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" + }, + "state": { + "context": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "coupon_lines": { + "description": "Coupons line data.", + "items": { + "properties": { + "code": { + "context": [ + "edit", + "view" + ], + "description": "Coupon code.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "discount": { + "context": [ + "edit", + "view" + ], + "description": "Discount total.", + "readonly": true, + "type": "string" + }, + "discount_tax": { + "context": [ + "edit", + "view" + ], + "description": "Discount total tax.", + "readonly": true, + "type": "string" + }, + "discount_type": { + "context": [ + "view" + ], + "description": "Discount type.", + "readonly": true, + "type": "string" + }, + "free_shipping": { + "context": [ + "view" + ], + "description": "Whether the coupon grants free shipping or not.", + "readonly": true, + "type": "boolean" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "nominal_amount": { + "context": [ + "view" + ], + "description": "Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).", + "readonly": true, + "type": "number" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "currency": { + "description": "Currency the order was created with, in ISO format.", + "enum": [ + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AUD", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BRL", + "BSD", + "BTC", + "BTN", + "BWP", + "BYN", + "BYR", + "BZD", + "CAD", + "CDF", + "CHF", + "CLP", + "CNY", + "COP", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "EUR", + "FJD", + "FKP", + "GBP", + "GEL", + "GGP", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IMP", + "INR", + "IQD", + "IRR", + "IRT", + "ISK", + "JEP", + "JMD", + "JOD", + "JPY", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRU", + "MUR", + "MVR", + "MWK", + "MXN", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PRB", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STN", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "USD", + "UYU", + "UZS", + "VEF", + "VES", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "required": false, + "type": "string" + }, + "customer_id": { + "description": "User ID who owns the order. 0 for guests.", + "required": false, + "type": "integer" + }, + "customer_note": { + "description": "Note left by customer during checkout.", + "required": false, + "type": "string" + }, + "fee_lines": { + "description": "Fee lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Fee name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of fee.", + "type": "string" + }, + "tax_status": { + "context": [ + "edit", + "view" + ], + "description": "Tax status of fee.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Tax subtotal.", + "readonly": true, + "type": "string" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "line_items": { + "description": "Line items data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "image": { + "context": [ + "edit", + "view" + ], + "description": "Properties of the main product image.", + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Image ID.", + "type": "integer" + }, + "src": { + "context": [ + "edit", + "view" + ], + "description": "Image URL.", + "format": "uri", + "type": "string" + } + }, + "readonly": true, + "type": "object" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "description": "Meta data.", + "items": { + "properties": { + "display_key": { + "context": [ + "edit", + "view" + ], + "description": "Meta key for UI display.", + "type": "string" + }, + "display_value": { + "context": [ + "edit", + "view" + ], + "description": "Meta value for UI display.", + "type": "string" + }, + "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" + }, + "type": "array" + }, + "name": { + "context": [ + "edit", + "view" + ], + "description": "Product name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "parent_name": { + "context": [ + "edit", + "view" + ], + "description": "Parent product name if the product is a variation.", + "type": "string" + }, + "price": { + "context": [ + "edit", + "view" + ], + "description": "Product price.", + "readonly": true, + "type": "number" + }, + "product_id": { + "context": [ + "edit", + "view" + ], + "description": "Product ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "quantity": { + "context": [ + "edit", + "view" + ], + "description": "Quantity ordered.", + "type": "integer" + }, + "sku": { + "context": [ + "edit", + "view" + ], + "description": "Product SKU.", + "readonly": true, + "type": "string" + }, + "subtotal": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal (before discounts).", + "type": "string" + }, + "subtotal_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line subtotal tax (before discounts).", + "readonly": true, + "type": "string" + }, + "tax_class": { + "context": [ + "edit", + "view" + ], + "description": "Tax class of product.", + "type": "string" + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "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" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + }, + "variation_id": { + "context": [ + "edit", + "view" + ], + "description": "Variation ID, if applicable.", + "type": "integer" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "manual_update": { + "description": "Set the action as manual so that the order note registers as \"added by user\".", + "required": false, + "type": "boolean" + }, + "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" + }, + "parent_id": { + "description": "Parent order ID.", + "required": false, + "type": "integer" + }, + "payment_method": { + "description": "Payment method ID.", + "required": false, + "type": "string" + }, + "payment_method_title": { + "description": "Payment method title.", + "required": false, + "type": "string" + }, + "set_paid": { + "description": "Define if the order is paid. It will set the status to processing and reduce stock items.", + "required": false, + "type": "boolean" + }, + "shipping": { + "description": "Shipping address.", + "properties": { + "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": "Country code in ISO 3166-1 alpha-2 format.", + "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": [ + "edit", + "view" + ], + "description": "ISO code or name of the county, state, province or district.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "shipping_lines": { + "description": "Shipping lines data.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Item ID.", + "readonly": true, + "type": "integer" + }, + "instance_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping instance ID.", + "type": "string" + }, + "meta_data": { + "context": [ + "edit", + "view" + ], + "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" + }, + "type": "array" + }, + "method_id": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method ID.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "method_title": { + "context": [ + "edit", + "view" + ], + "description": "Shipping method name.", + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + }, + "taxes": { + "context": [ + "edit", + "view" + ], + "description": "Line taxes.", + "items": { + "properties": { + "id": { + "context": [ + "edit", + "view" + ], + "description": "Tax rate ID", + "readonly": true, + "type": "integer" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Tax total.", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "readonly": true, + "type": "array" + }, + "total": { + "context": [ + "edit", + "view" + ], + "description": "Line total (after discounts).", + "type": "string" + }, + "total_tax": { + "context": [ + "edit", + "view" + ], + "description": "Line total tax (after discounts).", + "readonly": true, + "type": "string" + } + }, + "type": "object" + }, + "required": false, + "type": "array" + }, + "status": { + "description": "Order status.", + "enum": [ + "auto-draft", + "cancelled", + "checkout-draft", + "completed", + "failed", + "on-hold", + "pending", + "processing", + "refunded" + ], + "required": false, + "type": "string" + }, + "transaction_id": { + "description": "Unique transaction ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/payment_gateways": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/payment_gateways" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "Payment gateway description on checkout.", + "required": false, + "type": "string" + }, + "enabled": { + "description": "Payment gateway enabled status.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + }, + "order": { + "description": "Payment gateway sort order.", + "required": false, + "type": "integer" + }, + "settings": { + "description": "Payment gateway settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "color", + "email", + "image_width", + "multiselect", + "number", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "title": { + "description": "Payment gateway title on checkout.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "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", + "popularity", + "popularity", + "popularity", + "price", + "rating", + "rating", + "rating", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "search_sku": { + "description": "Limit results to those with a SKU that partially matches a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "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" + }, + "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": { + "default": "no", + "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": { + "default": "visible", + "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": { + "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 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": { + "default": false, + "description": "Featured product.", + "required": false, + "type": "boolean" + }, + "global_unique_id": { + "description": "GTIN, UPC, EAN or ISBN.", + "required": false, + "type": "string" + }, + "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": { + "default": false, + "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": { + "default": true, + "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": { + "default": false, + "description": "Allow one item to be bought in a single order.", + "required": false, + "type": "boolean" + }, + "status": { + "default": "publish", + "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": { + "default": "instock", + "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": { + "default": "taxable", + "description": "Tax status.", + "enum": [ + "none", + "shipping", + "taxable" + ], + "required": false, + "type": "string" + }, + "type": { + "default": "simple", + "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": { + "default": false, + "description": "If the product is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Product weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/(?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 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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/(?P[\\d]+)/duplicate": { + "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" + }, + "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": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/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": "Limit results to those matching a string.", + "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" + }, + "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" + }, + "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" + ], + "namespace": "wc/v3" + }, + "/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": [ + "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" + }, + "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" + }, + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/(?P[\\d]+)/variations/batch": { + "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": { + "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" + }, + "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" + }, + "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" + }, + "virtual": { + "description": "If the variation is virtual.", + "required": false, + "type": "boolean" + }, + "weight": { + "description": "Variation weight (kg).", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/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" + }, + "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" + }, + "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" + }, + "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" + }, + "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" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/attributes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "default": false, + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "order_by": { + "default": "menu_order", + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "default": "select", + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/attributes/(?P[\\d]+)/terms": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/attributes/(?P[\\d]+)/terms/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/attributes/(?P[\\d]+)/terms/batch": { + "endpoints": [ + { + "args": { + "attribute_id": { + "description": "Unique identifier for the attribute of the terms.", + "required": false, + "type": "integer" + }, + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Term name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": true, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/attributes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/attributes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "has_archives": { + "description": "Enable/Disable attribute archives.", + "required": false, + "type": "boolean" + }, + "name": { + "description": "Attribute name.", + "required": false, + "type": "string" + }, + "order_by": { + "description": "Default sort order.", + "enum": [ + "id", + "menu_order", + "name", + "name_num" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + }, + "type": { + "description": "Type of attribute.", + "enum": [ + "select" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/batch" + } + ] + }, + "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" + }, + "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" + }, + "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" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "default": "default", + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/categories/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/categories/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "display": { + "description": "Category archive display type.", + "enum": [ + "both", + "default", + "products", + "subcategories" + ], + "required": false, + "type": "string" + }, + "image": { + "description": "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" + }, + "menu_order": { + "description": "Menu order, used to custom sort the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Category name.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the resource.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/custom-fields/names": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/custom-fields/names" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "description": "Scope under which the request is made; determines fields present in response.", + "required": false, + "type": "string" + }, + "order": { + "default": "asc", + "description": "Order sort items ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/reviews": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to reviews 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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date_gmt", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "date_gmt", + "id", + "include", + "product" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": [], + "description": "Limit result set to reviews assigned to specific product IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "reviewer": { + "description": "Limit result set to reviews assigned to specific user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "reviewer_email": { + "default": null, + "description": "Limit result set to that from a specific author email.", + "format": "email", + "required": false, + "type": "string" + }, + "reviewer_exclude": { + "description": "Ensure result set excludes reviews assigned to specific user IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "approved", + "description": "Limit result set to reviews assigned a specific status.", + "enum": [ + "all", + "approved", + "hold", + "spam", + "trash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "product_id": { + "description": "Unique identifier for the product.", + "required": true, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "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": { + "default": "approved", + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "product_id": { + "description": "Unique identifier for the product that the review belongs to.", + "required": false, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "required": false, + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "format": "email", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "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", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/reviews/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/reviews/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "product_id": { + "description": "Unique identifier for the product that the review belongs to.", + "required": false, + "type": "integer" + }, + "product_name": { + "description": "Product name.", + "required": false, + "type": "string" + }, + "rating": { + "description": "Review rating (0 to 5).", + "required": false, + "type": "integer" + }, + "review": { + "description": "The content of the review.", + "required": false, + "type": "string" + }, + "reviewer": { + "description": "Reviewer name.", + "required": false, + "type": "string" + }, + "reviewer_email": { + "description": "Reviewer email.", + "format": "email", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of the review.", + "enum": [ + "approved", + "hold", + "spam", + "trash", + "unspam", + "untrash" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/shipping_classes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Shipping class name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/shipping_classes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/shipping_classes/slug-suggestion": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/shipping_classes/slug-suggestion" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Shipping class name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/suggested-products": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/suggested-products" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "attribute": { + "description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.", + "required": false, + "type": "string" + }, + "attribute_term": { + "description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to resources published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "categories": { + "default": [], + "description": "Limit result set to specific product categorie ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "category": { + "description": "Limit result set to products assigned a specific category ID.", + "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" + }, + "featured": { + "description": "Limit result set to featured products.", + "required": false, + "type": "boolean" + }, + "in_stock": { + "description": "Limit result set to products in stock or out of stock.", + "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" + }, + "limit": { + "default": 5, + "description": "Limit result set to specific amount of suggested products.", + "required": false, + "type": "integer" + }, + "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", + "popularity", + "popularity", + "rating", + "rating", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "shipping_class": { + "description": "Limit result set to products assigned a specific shipping class ID.", + "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" + }, + "tag": { + "description": "Limit result set to products assigned a specific tag ID.", + "required": false, + "type": "string" + }, + "tags": { + "default": [], + "description": "Limit result set to specific product tag ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "type": { + "description": "Limit result set to products assigned a specific type.", + "enum": [ + "external", + "grouped", + "simple", + "variable" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/tags": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide resources not assigned to any products.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by resource attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to resources assigned to a specific parent. Applies to hierarchical taxonomies only.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product": { + "default": null, + "description": "Limit result set to resources assigned to a specific product.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to resources with a specific slug.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Name for the resource.", + "required": true, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tag name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/products/tags/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/products/tags/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "description": { + "description": "HTML description of the resource.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tag name.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the resource unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/refunds": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/refunds" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "dp": { + "default": 2, + "description": "Number of decimal points to use in each resource.", + "required": false, + "type": "integer" + }, + "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" + }, + "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" + }, + "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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "order_item_display_meta": { + "default": false, + "description": "Only show meta which is meant to be displayed for an order.", + "required": false, + "type": "boolean" + }, + "orderby": { + "default": "date", + "description": "Sort collection by object attribute.", + "enum": [ + "date", + "id", + "include", + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports/coupons/totals": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/coupons/totals" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports/customers/totals": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/customers/totals" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports/orders/totals": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/orders/totals" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports/products/totals": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/products/totals" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports/reviews/totals": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/reviews/totals" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports/sales": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/sales" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "date_max": { + "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "date_min": { + "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "period": { + "description": "Report period.", + "enum": [ + "last_month", + "month", + "week", + "year" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/reports/top_sellers": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/reports/top_sellers" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "date_max": { + "description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "date_min": { + "description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.", + "format": "date", + "required": false, + "type": "string" + }, + "period": { + "description": "Report period.", + "enum": [ + "last_month", + "month", + "week", + "year" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/settings": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/settings/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/settings/(?P[\\w-]+)/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/settings/(?P[\\w-]+)/batch": { + "endpoints": [ + { + "args": { + "group": { + "description": "Settings group ID.", + "required": false, + "type": "string" + }, + "value": { + "description": "Setting value.", + "required": false, + "type": [ + "array", + "boolean", + "integer", + "null", + "number", + "object", + "string" + ] + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/settings/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/settings/batch" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/shipping/zones": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping/zones" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": { + "name": { + "description": "Shipping zone name.", + "required": true, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/shipping/zones/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Shipping zone name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Shipping zone order.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/shipping/zones/(?P[\\d]+)/locations": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "code": { + "description": "Shipping zone location code.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique ID for the resource.", + "required": false, + "type": "integer" + }, + "type": { + "description": "Shipping zone location type.", + "enum": [ + "continent", + "country", + "postcode", + "state" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/shipping/zones/(?P[\\d]+)/methods": { + "endpoints": [ + { + "args": { + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "enabled": { + "description": "Shipping method enabled status.", + "required": false, + "type": "boolean" + }, + "method_id": { + "description": "Shipping method ID.", + "required": true + }, + "order": { + "description": "Shipping method sort order.", + "required": false, + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "class", + "color", + "email", + "image_width", + "multiselect", + "number", + "order", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/shipping/zones/(?P[\\d]+)/methods/(?P[\\d]+)": { + "endpoints": [ + { + "args": { + "instance_id": { + "description": "Unique ID for the instance.", + "required": false, + "type": "integer" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "enabled": { + "description": "Shipping method enabled status.", + "required": false, + "type": "boolean" + }, + "instance_id": { + "description": "Unique ID for the instance.", + "required": false, + "type": "integer" + }, + "order": { + "description": "Shipping method sort order.", + "required": false, + "type": "integer" + }, + "settings": { + "description": "Shipping method settings.", + "properties": { + "default": { + "context": [ + "edit", + "view" + ], + "description": "Default value for the setting.", + "readonly": true, + "type": "string" + }, + "description": { + "context": [ + "edit", + "view" + ], + "description": "A human readable description for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "id": { + "context": [ + "edit", + "view" + ], + "description": "A unique identifier for the setting.", + "readonly": true, + "type": "string" + }, + "label": { + "context": [ + "edit", + "view" + ], + "description": "A human readable label for the setting used in interfaces.", + "readonly": true, + "type": "string" + }, + "placeholder": { + "context": [ + "edit", + "view" + ], + "description": "Placeholder text to be displayed in text inputs.", + "readonly": true, + "type": "string" + }, + "tip": { + "context": [ + "edit", + "view" + ], + "description": "Additional help text shown to the user about the setting.", + "readonly": true, + "type": "string" + }, + "type": { + "context": [ + "edit", + "view" + ], + "description": "Type of setting.", + "enum": [ + "checkbox", + "class", + "color", + "email", + "image_width", + "multiselect", + "number", + "order", + "password", + "radio", + "select", + "text", + "textarea" + ], + "readonly": true, + "type": "string" + }, + "value": { + "context": [ + "edit", + "view" + ], + "description": "Setting value.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Whether to bypass bin and force deletion.", + "required": false, + "type": "boolean" + }, + "instance_id": { + "description": "Unique ID for the instance.", + "required": false, + "type": "integer" + }, + "zone_id": { + "description": "Unique ID for the zone.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/shipping_methods": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/shipping_methods" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/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" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/system_status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/system_status/tools": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/system_status/tools" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/system_status/tools/(?P[\\w-]+)": { + "endpoints": [ + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "action": { + "description": "What running the tool will do.", + "required": false, + "type": "string" + }, + "description": { + "description": "Tool description.", + "required": false, + "type": "string" + }, + "id": { + "description": "A unique identifier for the tool.", + "required": false, + "type": "string" + }, + "message": { + "description": "Tool return message.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tool name.", + "required": false, + "type": "string" + }, + "success": { + "description": "Did the tool run successfully?", + "required": false, + "type": "boolean" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/taxes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes" + } + ] + }, + "endpoints": [ + { + "args": { + "class": { + "description": "Sort by tax class.", + "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": [ + "edit", + "view" + ], + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "order", + "description": "Sort collection by object attribute.", + "enum": [ + "id", + "order", + "priority" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "default": "standard", + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "default": false, + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "default": 1, + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "default": true, + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/taxes/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/taxes/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "cities": { + "description": "List of city names. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "city": { + "description": "City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'cities' should be used instead.", + "required": false, + "type": "string" + }, + "class": { + "description": "Tax class.", + "enum": [ + "reduced-rate", + "standard", + "zero-rate" + ], + "required": false, + "type": "string" + }, + "compound": { + "description": "Whether or not this is a compound rate.", + "required": false, + "type": "boolean" + }, + "country": { + "description": "Country ISO 3166 code.", + "required": false, + "type": "string" + }, + "name": { + "description": "Tax rate name.", + "required": false, + "type": "string" + }, + "order": { + "description": "Indicates the order that will appear in queries.", + "required": false, + "type": "integer" + }, + "postcode": { + "description": "Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, 'postcodes' should be used instead.", + "required": false, + "type": "string" + }, + "postcodes": { + "description": "List of postcodes / ZIPs. Introduced in WooCommerce 5.3.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "priority": { + "description": "Tax priority.", + "required": false, + "type": "integer" + }, + "rate": { + "description": "Tax rate.", + "required": false, + "type": "string" + }, + "shipping": { + "description": "Whether or not this tax rate also gets applied to shipping.", + "required": false, + "type": "boolean" + }, + "state": { + "description": "State code.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/taxes/classes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/taxes/classes" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "name": { + "description": "Tax class name.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/taxes/classes/(?P\\w[\\w\\s\\-]*)": { + "endpoints": [ + { + "args": { + "slug": { + "description": "Unique slug for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "slug": { + "description": "Unique slug for the resource.", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wc/v3" + }, + "/wc/v3/webhooks": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to resources published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific ids.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "all", + "description": "Limit result set to webhooks assigned a specific status.", + "enum": [ + "active", + "all", + "disabled", + "paused" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "delivery_url": { + "description": "Webhook delivery URL.", + "required": true, + "type": "string" + }, + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "default": "active", + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wc/v3" + }, + "/wc/v3/webhooks/(?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 resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + }, + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as resource does not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the resource.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wc/v3/webhooks/batch": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wc/v3/webhooks/batch" + } + ] + }, + "endpoints": [ + { + "args": { + "name": { + "description": "A friendly name for the webhook.", + "required": false, + "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.", + "required": false, + "type": "string" + }, + "status": { + "description": "Webhook status.", + "enum": [ + "active", + "disabled", + "paused" + ], + "required": false, + "type": "string" + }, + "topic": { + "description": "Webhook topic.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wc/v3" + }, + "/wccom-site/v3": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wccom-site/v3", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wccom-site/v3" + }, + "/wccom-site/v3/installer": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer" + } + ] + }, + "endpoints": [ + { + "args": { + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + }, + "run-until-step": { + "enum": [ + "activate_product", + "download_product", + "get_product_info", + "move_product", + "unpack_product" + ], + "required": true, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wccom-site/v3" + }, + "/wccom-site/v3/installer/reset": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/installer/reset" + } + ] + }, + "endpoints": [ + { + "args": { + "idempotency-key": { + "required": true, + "type": "string" + }, + "product-id": { + "required": true, + "type": "integer" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "PATCH", + "POST", + "PUT" + ], + "namespace": "wccom-site/v3" + }, + "/wccom-site/v3/ssr": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/ssr" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wccom-site/v3" + }, + "/wccom-site/v3/status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wccom-site/v3/status" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wccom-site/v3" + }, + "/wp-block-editor/v1": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wp-block-editor/v1", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-block-editor/v1" + }, + "/wp-block-editor/v1/export": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/export" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-block-editor/v1" + }, + "/wp-block-editor/v1/navigation-fallback": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/navigation-fallback" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-block-editor/v1" + }, + "/wp-block-editor/v1/url-details": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/url-details" + } + ] + }, + "endpoints": [ + { + "args": { + "url": { + "description": "The URL to process.", + "format": "uri", + "required": true, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-block-editor/v1" + }, + "/wp-site-health/v1": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wp-site-health/v1", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp-site-health/v1/directory-sizes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/directory-sizes" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp-site-health/v1/tests/authorization-header": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/authorization-header" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp-site-health/v1/tests/background-updates": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/background-updates" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp-site-health/v1/tests/dotorg-communication": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/dotorg-communication" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp-site-health/v1/tests/https-status": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/https-status" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp-site-health/v1/tests/loopback-requests": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/loopback-requests" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp-site-health/v1/tests/page-cache": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/page-cache" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp-site-health/v1" + }, + "/wp/v2": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2" } ] - } + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "required": false + }, + "namespace": { + "default": "wp/v2", + "required": false + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" }, - "/wp/v2/posts": { - "namespace": "wp/v2", + "/wp/v2/block-directory/search": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-directory/search" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "view" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "term": { + "description": "Limit result set to blocks matching the search term.", + "minLength": 1, + "required": true, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/block-patterns/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/categories" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/block-patterns/patterns": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/patterns" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/block-renderer/(?P[a-z0-9-]+/[a-z0-9-]+)": { + "endpoints": [ + { + "args": { + "attributes": { + "default": [], + "description": "Attributes for the block.", + "required": false, + "type": "object" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit" + ], + "required": false, + "type": "string" + }, + "name": { + "description": "Unique registered name for the block.", + "required": false, + "type": "string" + }, + "post_id": { + "description": "ID of the post context.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET", + "POST" + ] + } + ], "methods": [ "GET", "POST" ], + "namespace": "wp/v2" + }, + "/wp/v2/block-types": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-types" + } + ] + }, "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" + }, + "namespace": { + "description": "Block namespace.", + "required": false, + "type": "string" + } + }, "methods": [ "GET" - ], + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "namespace": { + "description": "Block namespace.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "name": { + "description": "Block name.", + "required": false, + "type": "string" + }, + "namespace": { + "description": "Block namespace.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/blocks": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks" + } + ] + }, + "endpoints": [ + { "allow_batch": { "v1": true }, "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "author": { - "description": "Limit result set to posts assigned to specific authors.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "author_exclude": { - "description": "Ensure result set excludes posts assigned to specific authors.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false + "required": false, + "type": "string" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "modified_after": { + "description": "Limit response to posts modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false + "required": false, + "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false + "required": false, + "type": "integer" }, "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", "default": "desc", + "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], - "required": false + "required": false, + "type": "string" }, "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", "default": "date", + "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ], - "required": false + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", - "type": "array", "items": { "enum": [ - "post_title", "post_content", - "post_excerpt" + "post_excerpt", + "post_title" ], "type": "string" }, - "required": false + "required": false, + "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", "items": { "type": "string" }, - "required": false + "required": false, + "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", - "type": "array", "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" }, - "required": false + "required": false, + "type": "array" }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", - "type": "string", "enum": [ "AND", "OR" ], - "required": false + "required": false, + "type": "string" }, - "categories": { - "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", - "type": [ - "object", - "array" - ], + "wp_pattern_category": { + "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", "oneOf": [ { - "title": "Term ID List", "description": "Match terms with the listed IDs.", - "type": "array", "items": { "type": "integer" - } + }, + "title": "Term ID List", + "type": "array" }, { - "title": "Term ID Taxonomy Query", + "additionalProperties": false, "description": "Perform an advanced term query.", - "type": "object", "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - }, "operator": { + "default": "OR", "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", "enum": [ "AND", "OR" ], - "default": "OR" - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "categories_exclude": { - "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] + "type": "string" }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "tags": { - "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { "terms": { + "default": [], "description": "Term IDs.", - "type": "array", "items": { "type": "integer" }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "default": "OR" + "type": "array" } }, - "additionalProperties": false + "title": "Term ID Taxonomy Query", + "type": "object" } ], - "required": false - }, - "tags_exclude": { - "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", + "required": false, "type": [ - "object", - "array" - ], + "array", + "object" + ] + }, + "wp_pattern_category_exclude": { + "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", "oneOf": [ { - "title": "Term ID List", "description": "Match terms with the listed IDs.", - "type": "array", "items": { "type": "integer" - } + }, + "title": "Term ID List", + "type": "array" }, { - "title": "Term ID Taxonomy Query", + "additionalProperties": false, "description": "Perform an advanced term query.", - "type": "object", "properties": { "terms": { + "default": [], "description": "Term IDs.", - "type": "array", "items": { "type": "integer" }, - "default": [] + "type": "array" } }, - "additionalProperties": false + "title": "Term ID Taxonomy Query", + "type": "object" } ], - "required": false - }, - "sticky": { - "description": "Limit result set to items that are sticky.", - "type": "boolean", - "required": false + "required": false, + "type": [ + "array", + "object" + ] } - } + }, + "methods": [ + "GET" + ] }, { - "methods": [ - "POST" - ], "allow_batch": { "v1": true }, "args": { + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], "format": "date-time", - "required": false + "required": false, + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "required": false + "required": false, + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", - "type": "object", "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", "context": [ "edit" - ] + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" }, "rendered": { + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true + "readonly": true, + "type": "string" } }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "format": { - "description": "The format for the post.", - "type": "string", - "enum": [ - "standard", - "aside", - "chat", - "gallery", - "link", - "image", - "quote", - "status", - "video", - "audio" - ], - "required": false + "required": false, + "type": "object" }, "meta": { "description": "Meta fields.", - "type": "object", "properties": { "footnotes": { - "type": "string", + "default": "", "description": "", - "default": "" + "type": "string" + }, + "wp_pattern_sync_status": { + "default": "", + "description": "", + "enum": [ + "partial", + "unsynced" + ], + "type": "string" } }, - "required": false + "required": false, + "type": "object" }, - "sticky": { - "description": "Whether or not the post should be treated as sticky.", - "type": "boolean", - "required": false + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" }, "template": { "description": "The theme file to use to display the post.", - "type": "string", - "required": false + "required": false, + "type": "string" }, - "categories": { - "description": "The terms assigned to the object in the category taxonomy.", - "type": "array", + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "items": { "type": "integer" }, - "required": false - }, - "tags": { - "description": "The terms assigned to the object in the post_tag taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false + "required": false, + "type": "array" } - } + }, + "methods": [ + "POST" + ] } ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/posts" - } - ] - } - }, - "/wp/v2/posts/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", "methods": [ "GET", - "POST", - "PUT", - "PATCH", - "DELETE" + "POST" ], + "namespace": "wp/v2" + }, + "/wp/v2/blocks/(?P[\\d]+)": { "endpoints": [ { - "methods": [ - "GET" - ], "allow_batch": { "v1": true }, "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" }, "excerpt_length": { "description": "Override the default excerpt length.", - "type": "integer", - "required": false + "required": false, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" }, "password": { "description": "The password for the post if it is password protected.", - "type": "string", - "required": false + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] }, { - "methods": [ - "POST", - "PUT", - "PATCH" - ], "allow_batch": { "v1": true }, "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": "object" }, "date": { "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], "format": "date-time", - "required": false + "required": false, + "type": [ + "null", + "string" + ] }, "date_gmt": { "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "required": false + "required": false, + "type": [ + "null", + "string" + ] }, "excerpt": { "description": "The excerpt for the post.", - "type": "object", "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", "context": [ "edit" - ] + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" }, "rendered": { + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true + "readonly": true, + "type": "string" } }, - "required": false + "required": false, + "type": "object" }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "format": { - "description": "The format for the post.", - "type": "string", - "enum": [ - "standard", - "aside", - "chat", - "gallery", - "link", - "image", - "quote", - "status", - "video", - "audio" - ], - "required": false + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" }, "meta": { "description": "Meta fields.", - "type": "object", "properties": { "footnotes": { - "type": "string", + "default": "", "description": "", - "default": "" + "type": "string" + }, + "wp_pattern_sync_status": { + "default": "", + "description": "", + "enum": [ + "partial", + "unsynced" + ], + "type": "string" } }, - "required": false + "required": false, + "type": "object" }, - "sticky": { - "description": "Whether or not the post should be treated as sticky.", - "type": "boolean", - "required": false + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" }, "template": { "description": "The theme file to use to display the post.", - "type": "string", - "required": false + "required": false, + "type": "string" }, - "categories": { - "description": "The terms assigned to the object in the category taxonomy.", - "type": "array", + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", "items": { "type": "integer" }, - "required": false - }, - "tags": { - "description": "The terms assigned to the object in the post_tag taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false + "required": false, + "type": "array" } - } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { - "methods": [ - "DELETE" - ], "allow_batch": { "v1": true }, "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, "force": { - "type": "boolean", "default": false, "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/revisions": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "relevance", - "slug", - "include_slugs", - "title" - ], - "required": false - } - } - } - ] - }, - "/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false + "required": false, + "type": "boolean" }, "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" } - } - }, - { + }, "methods": [ "DELETE" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as revisions do not support binning.", - "required": false - } - } + ] } - ] + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" }, - "/wp/v2/posts/(?P\u003Cid\u003E[\\d]+)/autosaves": { - "namespace": "wp/v2", + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + }, + "wp_pattern_sync_status": { + "default": "", + "description": "", + "enum": [ + "partial", + "unsynced" + ], + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "wp_pattern_category": { + "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], "methods": [ "GET", "POST" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "format": { - "description": "The format for the post.", - "type": "string", - "enum": [ - "standard", - "aside", - "chat", - "gallery", - "link", - "image", - "quote", - "status", - "video", - "audio" - ], - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "footnotes": { - "type": "string", - "description": "", - "default": "" - } - }, - "required": false - }, - "sticky": { - "description": "Whether or not the post should be treated as sticky.", - "type": "boolean", - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "categories": { - "description": "The terms assigned to the object in the category taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "tags": { - "description": "The terms assigned to the object in the post_tag taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - } - ] + "namespace": "wp/v2" }, - "/wp/v2/posts/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], + "/wp/v2/blocks/(?P[\\d]+)/autosaves/(?P[\\d]+)": { "endpoints": [ { - "methods": [ - "GET" - ], "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false + "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": "The ID for the autosave.", - "type": "integer", - "required": false + "required": false, + "type": "integer" }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" } - } - } - ] - }, - "/wp/v2/pages": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { + }, "methods": [ "GET" - ], + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "include_slugs", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as revisions do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/categories": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/categories" + } + ] + }, + "endpoints": [ + { "allow_batch": { "v1": true }, "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "author": { - "description": "Limit result set to posts assigned to specific authors.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "author_exclude": { - "description": "Ensure result set excludes posts assigned to specific authors.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "before": { - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" }, "exclude": { + "default": [], "description": "Ensure result set excludes specific IDs.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "required": false, + "type": "boolean" }, "include": { + "default": [], "description": "Limit result set to specific IDs.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false - }, - "menu_order": { - "description": "Limit result set to posts with a specific menu_order value.", - "type": "integer", - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false + "required": false, + "type": "array" }, "order": { + "default": "asc", "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", "enum": [ "asc", "desc" ], - "required": false + "required": false, + "type": "string" }, "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", - "default": "date", + "default": "name", + "description": "Sort collection by term attribute.", "enum": [ - "author", - "date", + "count", + "description", "id", "include", - "modified", - "parent", - "relevance", - "slug", "include_slugs", - "title", - "menu_order" + "name", + "slug", + "term_group" ], - "required": false + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" }, "parent": { - "description": "Limit result set to items with particular parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false + "description": "Limit result set to terms assigned to a specific parent.", + "required": false, + "type": "integer" }, - "parent_exclude": { - "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" }, - "search_columns": { - "default": [], - "description": "Array of column names to be searched.", - "type": "array", + "post": { + "default": null, + "description": "Limit result set to terms assigned to a specific post.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to terms with one or more specific slugs.", "items": { - "enum": [ - "post_title", - "post_content", - "post_excerpt" - ], "type": "string" }, - "required": false + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/categories/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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 term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Required to be true, as terms do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/comments": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/comments" + } + ] + }, + "endpoints": [ + { + "args": { + "after": { + "description": "Limit response to comments published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "author": { + "description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "author_email": { + "default": null, + "description": "Limit result set to that from a specific author email. Requires authorisation.", + "format": "email", + "required": false, + "type": "string" + }, + "author_exclude": { + "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to comments 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", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date_gmt", + "description": "Sort collection by comment attribute.", + "enum": [ + "date", + "date_gmt", + "id", + "include", + "parent", + "post", + "type" + ], + "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 comments of specific parent IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "parent_exclude": { + "default": [], + "description": "Ensure result set excludes specific parent IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "password": { + "description": "The password for the post if it is password protected.", + "required": false, + "type": "string" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "post": { + "default": [], + "description": "Limit result set to comments assigned to specific post IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "default": "approve", + "description": "Limit result set to comments assigned a specific status. Requires authorisation.", + "required": false, + "type": "string" + }, + "type": { + "default": "comment", + "description": "Limit result set to comments assigned a specific type. Requires authorisation.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "author": { + "description": "The ID of the user object, if author was a user.", + "required": false, + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "format": "email", + "required": false, + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "format": "ip", + "required": false, + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "required": false, + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "format": "uri", + "required": false, + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Content for the comment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the comment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the comment was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": "string" + }, + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "format": "date-time", + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "parent": { + "default": 0, + "description": "The ID for the parent of the comment.", + "required": false, + "type": "integer" + }, + "post": { + "default": 0, + "description": "The ID of the associated post object.", + "required": false, + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/comments/(?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 comment.", + "required": false, + "type": "integer" + }, + "password": { + "description": "The password for the parent post of the comment (if the post is password protected).", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "author": { + "description": "The ID of the user object, if author was a user.", + "required": false, + "type": "integer" + }, + "author_email": { + "description": "Email address for the comment author.", + "format": "email", + "required": false, + "type": "string" + }, + "author_ip": { + "description": "IP address for the comment author.", + "format": "ip", + "required": false, + "type": "string" + }, + "author_name": { + "description": "Display name for the comment author.", + "required": false, + "type": "string" + }, + "author_url": { + "description": "URL for the comment author.", + "format": "uri", + "required": false, + "type": "string" + }, + "author_user_agent": { + "description": "User agent for the comment author.", + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the comment.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Content for the comment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the comment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the comment was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": "string" + }, + "date_gmt": { + "description": "The date the comment was published, as GMT.", + "format": "date-time", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the comment.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the comment.", + "required": false, + "type": "integer" + }, + "post": { + "description": "The ID of the associated post object.", + "required": false, + "type": "integer" + }, + "status": { + "description": "State of the comment.", + "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 comment.", + "required": false, + "type": "integer" + }, + "password": { + "description": "The password for the parent post of the comment (if the post is password protected).", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/font-collections": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-collections" + } + ] + }, + "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" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/font-families": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-families" + } + ] + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "id", + "description": "Sort collection by post attribute.", + "enum": [ + "id", + "include" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", "items": { "type": "string" }, - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to posts assigned one or more statuses.", - "type": "array", - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - }, - "required": false + "required": false, + "type": "array" } - } + }, + "methods": [ + "GET" + ] }, { + "args": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "theme_json_version": { + "default": 3, + "description": "Version of the theme.json schema used for the typography settings.", + "maximum": 3, + "minimum": 2, + "required": false, + "type": "integer" + } + }, "methods": [ "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "menu_order": { - "description": "The order of the post in relation to other posts.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "footnotes": { - "type": "string", - "description": "", - "default": "" - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - } - } + ] } ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pages" - } - ] - } - }, - "/wp/v2/pages/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "excerpt_length": { - "description": "Override the default excerpt length.", - "type": "integer", - "required": false - }, - "password": { - "description": "The password for the post if it is password protected.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "menu_order": { - "description": "The order of the post in relation to other posts.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "footnotes": { - "type": "string", - "description": "", - "default": "" - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/revisions": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "relevance", - "slug", - "include_slugs", - "title" - ], - "required": false - } - } - } - ] - }, - "/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as revisions do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/pages/(?P\u003Cid\u003E[\\d]+)/autosaves": { - "namespace": "wp/v2", "methods": [ "GET", "POST" ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "font_family_id": { + "description": "The ID for the parent font family of the font face.", + "required": true, + "type": "integer" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "id", + "description": "Sort collection by post attribute.", + "enum": [ + "id", + "include" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, "methods": [ "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } + ] }, { + "args": { + "font_face_settings": { + "description": "font-face declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "font_family_id": { + "description": "The ID for the parent font family of the font face.", + "required": true, + "type": "integer" + }, + "theme_json_version": { + "default": 3, + "description": "Version of the theme.json schema used for the typography settings.", + "maximum": 3, + "minimum": 2, + "required": false, + "type": "integer" + } + }, "methods": [ "POST" - ], + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/font-families/(?P[\\d]+)/font-faces/(?P[\\d]+)": { + "endpoints": [ + { "args": { - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "edit", + "embed", + "view" ], - "required": false + "required": false, + "type": "string" }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false + "font_family_id": { + "description": "The ID for the parent font family of the font face.", + "required": true, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the font face.", + "required": true, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "font_family_id": { + "description": "The ID for the parent font family of the font face.", + "required": true, + "type": "integer" + }, + "force": { + "default": false, + "description": "Whether to bypass Bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the font face.", + "required": true, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "font_family_settings": { + "description": "font-family declaration in theme.json format, encoded as a string.", + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "theme_json_version": { + "default": 3, + "description": "Version of the theme.json schema used for the typography settings.", + "maximum": 3, + "minimum": 2, + "required": false, + "type": "integer" + } + }, + "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 post.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/global-styles/(?P[\\/\\w-]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": false + }, + "args": { + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": false + }, + "args": { + "settings": { + "description": "Global settings.", + "required": false, + "type": [ + "object" + ] + }, + "styles": { + "description": "Global styles.", + "required": false, + "type": [ + "object" + ] }, "title": { - "description": "The title for the post.", - "type": "object", + "description": "Title of the global styles variation.", "properties": { "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", "context": [ - "edit" - ] + "edit", + "embed", + "view" + ], + "description": "Title for the global styles variation, as it exists in the database.", + "type": "string" }, "rendered": { + "context": [ + "edit", + "embed", + "view" + ], "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true + "readonly": true, + "type": "string" } }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "menu_order": { - "description": "The order of the post in relation to other posts.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "footnotes": { - "type": "string", - "description": "", - "default": "" - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false + "required": false, + "type": [ + "object", + "string" + ] } - } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] } - ] + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" }, - "/wp/v2/pages/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], + "namespace": "wp/v2" + }, + "/wp/v2/global-styles/(?P[\\d]+)/revisions/(?P[\\d]+)": { "endpoints": [ { - "methods": [ - "GET" - ], "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false + "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": "The ID for the autosave.", - "type": "integer", - "required": false + "description": "Unique identifier for the global styles revision.", + "required": false, + "type": "integer" }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "parent": { + "description": "The ID for the parent of the global styles revision.", + "required": false, + "type": "integer" } - } + }, + "methods": [ + "GET" + ] } - ] + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/global-styles/themes/(?P[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": { + "endpoints": [ + { + "allow_batch": { + "v1": false + }, + "args": { + "stylesheet": { + "description": "The theme identifier", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/global-styles/themes/(?P[^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)": { + "endpoints": [ + { + "allow_batch": { + "v1": false + }, + "args": { + "stylesheet": { + "description": "The theme identifier", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" }, "/wp/v2/media": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/media" + } + ] + }, "endpoints": [ { - "methods": [ - "GET" - ], "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false + "required": false, + "type": "string" }, "author": { + "default": [], "description": "Limit result set to posts assigned to specific authors.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false + "required": false, + "type": "array" }, "author_exclude": { + "default": [], "description": "Ensure result set excludes posts assigned to specific authors.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false + "required": false, + "type": "array" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "media_type": { + "default": null, + "description": "Limit result set to attachments of a particular media type.", + "enum": [ + "application", + "image", + "video" + ], + "required": false, + "type": "string" + }, + "mime_type": { + "default": null, + "description": "Limit result set to attachments of a particular MIME type.", + "required": false, + "type": "string" + }, + "modified_after": { + "description": "Limit response to posts modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false + "required": false, + "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false + "required": false, + "type": "integer" }, "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", "default": "desc", + "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], - "required": false + "required": false, + "type": "string" }, "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", "default": "date", + "description": "Sort collection by post attribute.", "enum": [ "author", "date", "id", "include", + "include_slugs", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ], - "required": false + "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 items with particular parent IDs.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false + "required": false, + "type": "array" }, "parent_exclude": { + "default": [], "description": "Limit result set to all items except those of a particular parent ID.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", - "type": "array", "items": { "enum": [ - "post_title", "post_content", - "post_excerpt" + "post_excerpt", + "post_title" ], "type": "string" }, - "required": false + "required": false, + "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", "items": { "type": "string" }, - "required": false + "required": false, + "type": "array" }, "status": { "default": "inherit", "description": "Limit result set to posts assigned one or more statuses.", - "type": "array", "items": { "enum": [ "inherit", @@ -87976,537 +88440,471 @@ ], "type": "string" }, - "required": false - }, - "media_type": { - "default": null, - "description": "Limit result set to attachments of a particular media type.", - "type": "string", - "enum": [ - "image", - "video", - "application" - ], - "required": false - }, - "mime_type": { - "default": null, - "description": "Limit result set to attachments of a particular MIME type.", - "type": "string", - "required": false + "required": false, + "type": "array" } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "author": { - "description": "The ID for the author of the post.", - "type": "integer", - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "alt_text": { - "description": "Alternative text to display when attachment is not displayed.", - "type": "string", - "required": false - }, - "caption": { - "description": "The attachment caption.", - "type": "object", - "properties": { - "raw": { - "description": "Caption for the attachment, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML caption for the attachment, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "description": { - "description": "The attachment description.", - "type": "object", - "properties": { - "raw": { - "description": "Description for the attachment, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML description for the attachment, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - } - }, - "required": false - }, - "post": { - "description": "The ID for the associated post of the attachment.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/media" - } - ] - } - }, - "/wp/v2/media/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { + }, "methods": [ "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } + ] }, { - "methods": [ - "POST", - "PUT", - "PATCH" - ], "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false + "alt_text": { + "description": "Alternative text to display when attachment is not displayed.", + "required": false, + "type": "string" }, "author": { "description": "The ID for the author of the post.", - "type": "integer", - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "comment_status": { - "description": "Whether or not comments are open on the post.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "ping_status": { - "description": "Whether or not the post can be pinged.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "alt_text": { - "description": "Alternative text to display when attachment is not displayed.", - "type": "string", - "required": false + "required": false, + "type": "integer" }, "caption": { "description": "The attachment caption.", - "type": "object", "properties": { "raw": { - "description": "Caption for the attachment, as it exists in the database.", - "type": "string", "context": [ "edit" - ] + ], + "description": "Caption for the attachment, as it exists in the database.", + "type": "string" }, "rendered": { - "description": "HTML caption for the attachment, transformed for display.", - "type": "string", "context": [ - "view", "edit", - "embed" + "embed", + "view" ], - "readonly": true + "description": "HTML caption for the attachment, transformed for display.", + "readonly": true, + "type": "string" } }, - "required": false + "required": false, + "type": "object" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] }, "description": { "description": "The attachment description.", - "type": "object", "properties": { "raw": { - "description": "Description for the attachment, as it exists in the database.", - "type": "string", "context": [ "edit" - ] - }, - "rendered": { - "description": "HTML description for the attachment, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" ], - "readonly": true + "description": "Description for the attachment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML description for the attachment, transformed for display.", + "readonly": true, + "type": "string" } }, - "required": false + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" }, "post": { "description": "The ID for the associated post of the attachment.", - "type": "integer", - "required": false + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" } - } - }, - { + }, "methods": [ - "DELETE" - ], + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/media/(?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 post.", - "type": "integer", - "required": false + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "alt_text": { + "description": "Alternative text to display when attachment is not displayed.", + "required": false, + "type": "string" }, + "author": { + "description": "The ID for the author of the post.", + "required": false, + "type": "integer" + }, + "caption": { + "description": "The attachment caption.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Caption for the attachment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML caption for the attachment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "description": { + "description": "The attachment description.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Description for the attachment, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML description for the attachment, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "post": { + "description": "The ID for the associated post of the attachment.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { "force": { - "type": "boolean", "default": false, "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/media/(?P\u003Cid\u003E[\\d]+)/post-process": { - "namespace": "wp/v2", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { - "id": { - "description": "Unique identifier for the attachment.", - "type": "integer", - "required": false + "required": false, + "type": "boolean" }, - "action": { - "type": "string", - "enum": [ - "create-image-subsizes" - ], - "required": true + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" } - } + }, + "methods": [ + "DELETE" + ] } - ] - }, - "/wp/v2/media/(?P\u003Cid\u003E[\\d]+)/edit": { - "namespace": "wp/v2", - "methods": [ - "POST" ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/media/(?P[\\d]+)/edit": { "endpoints": [ { - "methods": [ - "POST" - ], "args": { - "src": { - "description": "URL to the edited image file.", - "type": "string", - "format": "uri", - "required": true + "height": { + "description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "number" }, "modifiers": { "description": "Array of image edits.", - "type": "array", - "minItems": 1, "items": { "description": "Image edit.", - "type": "object", - "required": [ - "type", - "args" - ], "oneOf": [ { - "title": "Rotation", "properties": { - "type": { - "description": "Rotation type.", - "type": "string", - "enum": [ - "rotate" - ] - }, "args": { "description": "Rotation arguments.", - "type": "object", - "required": [ - "angle" - ], "properties": { "angle": { "description": "Angle to rotate clockwise in degrees.", "type": "number" } - } + }, + "required": [ + "angle" + ], + "type": "object" + }, + "type": { + "description": "Rotation type.", + "enum": [ + "rotate" + ], + "type": "string" } - } + }, + "title": "Rotation" }, { - "title": "Crop", "properties": { - "type": { - "description": "Crop type.", - "type": "string", - "enum": [ - "crop" - ] - }, "args": { "description": "Crop arguments.", - "type": "object", - "required": [ - "left", - "top", - "width", - "height" - ], "properties": { + "height": { + "description": "Height of the crop as a percentage of the image height.", + "type": "number" + }, "left": { "description": "Horizontal position from the left to begin the crop as a percentage of the image width.", "type": "number" @@ -88518,9464 +88916,3476 @@ "width": { "description": "Width of the crop as a percentage of the image width.", "type": "number" - }, - "height": { - "description": "Height of the crop as a percentage of the image height.", - "type": "number" } - } + }, + "required": [ + "height", + "left", + "top", + "width" + ], + "type": "object" + }, + "type": { + "description": "Crop type.", + "enum": [ + "crop" + ], + "type": "string" } - } + }, + "title": "Crop" } - ] + ], + "required": [ + "args", + "type" + ], + "type": "object" }, - "required": false + "minItems": 1, + "required": false, + "type": "array" }, "rotation": { "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: use `modifiers` instead.", - "type": "integer", - "minimum": 0, + "exclusiveMaximum": true, "exclusiveMinimum": true, "maximum": 360, - "exclusiveMaximum": true, - "required": false - }, - "x": { - "description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead.", - "type": "number", "minimum": 0, - "maximum": 100, - "required": false + "required": false, + "type": "integer" }, - "y": { - "description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead.", - "type": "number", - "minimum": 0, - "maximum": 100, - "required": false + "src": { + "description": "URL to the edited image file.", + "format": "uri", + "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", - "minimum": 0, "maximum": 100, - "required": false + "minimum": 0, + "required": false, + "type": "number" }, - "height": { - "description": "As a percentage of the image, the height to which to crop the image. DEPRECATED: use `modifiers` instead.", - "type": "number", - "minimum": 0, + "x": { + "description": "As a percentage of the image, the x position from which to start the crop. DEPRECATED: use `modifiers` instead.", "maximum": 100, - "required": false + "minimum": 0, + "required": false, + "type": "number" + }, + "y": { + "description": "As a percentage of the image, the y position from which to start the crop. DEPRECATED: use `modifiers` instead.", + "maximum": 100, + "minimum": 0, + "required": false, + "type": "number" } - } - } - ] - }, - "/wp/v2/menu-items": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 100, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "menu_order", - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "menu_order" - ], - "required": false - }, - "search_columns": { - "default": [], - "description": "Array of column names to be searched.", - "type": "array", - "items": { - "enum": [ - "post_title", - "post_content", - "post_excerpt" - ], - "type": "string" - }, - "required": false - }, - "slug": { - "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to posts assigned one or more statuses.", - "type": "array", - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - }, - "required": false - }, - "tax_relation": { - "description": "Limit result set based on relationship between multiple taxonomies.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "required": false - }, - "menus": { - "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "default": "OR" - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "menus_exclude": { - "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "menu_order": { - "description": "Limit result set to posts with a specific menu_order value.", - "type": "integer", - "required": false - } - } - }, - { "methods": [ "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "title": { - "description": "The title for the object.", - "type": [ - "string", - "object" - ], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "type": { - "default": "custom", - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "type": "string", - "enum": [ - "taxonomy", - "post_type", - "post_type_archive", - "custom" - ], - "required": false - }, - "status": { - "default": "publish", - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "parent": { - "default": 0, - "description": "The ID for the parent of the object.", - "type": "integer", - "minimum": 0, - "required": false - }, - "attr_title": { - "description": "Text for the title attribute of the link element for this menu item.", - "type": "string", - "required": false - }, - "classes": { - "description": "Class names for the link element of this menu item.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "description": { - "description": "The description of this menu item.", - "type": "string", - "required": false - }, - "menu_order": { - "default": 1, - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", - "type": "integer", - "minimum": 1, - "required": false - }, - "object": { - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", - "type": "string", - "required": false - }, - "object_id": { - "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.", - "type": "integer", - "minimum": 0, - "required": false - }, - "target": { - "description": "The target attribute of the link element for this menu item.", - "type": "string", - "enum": [ - "_blank", - "" - ], - "required": false - }, - "url": { - "description": "The URL to which this menu item points.", - "type": "string", - "format": "uri", - "required": false - }, - "xfn": { - "description": "The XFN relationship expressed in the link of this menu item.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "menus": { - "description": "The terms assigned to the object in the nav_menu taxonomy.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } + ] } ], + "methods": [ + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/media/(?P[\\d]+)/post-process": { + "endpoints": [ + { + "args": { + "action": { + "enum": [ + "create-image-subsizes" + ], + "required": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the attachment.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/menu-items": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-items" } ] - } - }, - "/wp/v2/menu-items/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], + }, "endpoints": [ { - "methods": [ - "GET" - ], "allow_batch": { "v1": true }, "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "title": { - "description": "The title for the object.", - "type": [ - "string", - "object" - ], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "type": { - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "type": "string", - "enum": [ - "taxonomy", - "post_type", - "post_type_archive", - "custom" - ], - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "minimum": 0, - "required": false - }, - "attr_title": { - "description": "Text for the title attribute of the link element for this menu item.", - "type": "string", - "required": false - }, - "classes": { - "description": "Class names for the link element of this menu item.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "description": { - "description": "The description of this menu item.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", - "type": "integer", - "minimum": 1, - "required": false - }, - "object": { - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", - "type": "string", - "required": false - }, - "object_id": { - "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", - "minimum": 0, - "required": false - }, - "target": { - "description": "The target attribute of the link element for this menu item.", - "type": "string", - "enum": [ - "_blank", - "" - ], - "required": false - }, - "url": { - "description": "The URL to which this menu item points.", - "type": "string", - "format": "uri", - "required": false - }, - "xfn": { - "description": "The XFN relationship expressed in the link of this menu item.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "menus": { - "description": "The terms assigned to the object in the nav_menu taxonomy.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/menu-items/(?P\u003Cid\u003E[\\d]+)/autosaves": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent": { - "description": "The ID for the parent of the object.", - "type": "integer", - "minimum": 0, - "required": false - }, - "title": { - "description": "The title for the object.", - "type": [ - "string", - "object" - ], - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "type": { - "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", - "type": "string", - "enum": [ - "taxonomy", - "post_type", - "post_type_archive", - "custom" - ], - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "attr_title": { - "description": "Text for the title attribute of the link element for this menu item.", - "type": "string", - "required": false - }, - "classes": { - "description": "Class names for the link element of this menu item.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "description": { - "description": "The description of this menu item.", - "type": "string", - "required": false - }, - "menu_order": { - "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", - "type": "integer", - "minimum": 1, - "required": false - }, - "object": { - "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", - "type": "string", - "required": false - }, - "object_id": { - "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", - "minimum": 0, - "required": false - }, - "target": { - "description": "The target attribute of the link element for this menu item.", - "type": "string", - "enum": [ - "_blank", - "" - ], - "required": false - }, - "url": { - "description": "The URL to which this menu item points.", - "type": "string", - "format": "uri", - "required": false - }, - "xfn": { - "description": "The XFN relationship expressed in the link of this menu item.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "menus": { - "description": "The terms assigned to the object in the nav_menu taxonomy.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - } - ] - }, - "/wp/v2/menu-items/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "id": { - "description": "The ID for the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/blocks": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, "after": { "description": "Limit response to posts published after a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false + "required": false, + "type": "string" }, "before": { "description": "Limit response to posts published before a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "menu_order": { + "description": "Limit result set to posts with a specific menu_order value.", + "required": false, + "type": "integer" + }, + "menus": { + "description": "Limit result set to items with specific terms assigned in the menus taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "menus_exclude": { + "description": "Limit result set to items, except those with specific terms assigned in the menus taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "modified_after": { + "description": "Limit response to posts modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" }, "modified_before": { "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "type": "string", "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false + "required": false, + "type": "string" }, "offset": { "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false + "required": false, + "type": "integer" }, "order": { + "default": "asc", "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", "enum": [ "asc", "desc" ], - "required": false + "required": false, + "type": "string" }, "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", - "default": "date", + "default": "menu_order", + "description": "Sort collection by object attribute.", "enum": [ "author", "date", "id", "include", + "include_slugs", + "menu_order", "modified", "parent", "relevance", "slug", - "include_slugs", "title" ], - "required": false + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 100, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" }, "search_columns": { "default": [], "description": "Array of column names to be searched.", - "type": "array", "items": { "enum": [ - "post_title", "post_content", - "post_excerpt" + "post_excerpt", + "post_title" ], "type": "string" }, - "required": false + "required": false, + "type": "array" }, "slug": { "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", "items": { "type": "string" }, - "required": false + "required": false, + "type": "array" }, "status": { "default": "publish", "description": "Limit result set to posts assigned one or more statuses.", - "type": "array", "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" }, - "required": false + "required": false, + "type": "array" }, "tax_relation": { "description": "Limit result set based on relationship between multiple taxonomies.", - "type": "string", "enum": [ "AND", "OR" ], - "required": false - }, - "wp_pattern_category": { - "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "default": "OR" - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "wp_pattern_category_exclude": { - "description": "Limit result set to items, except those with specific terms assigned in the wp_pattern_category taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - } - }, - "additionalProperties": false - } - ], - "required": false + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] }, { - "methods": [ - "POST" - ], "allow_batch": { "v1": true }, "args": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false + "attr_title": { + "description": "Text for the title attribute of the link element for this menu item.", + "required": false, + "type": "string" }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "wp_pattern_sync_status": { - "type": "string", - "description": "", - "default": "", - "enum": [ - "partial", - "unsynced" - ] - }, - "footnotes": { - "type": "string", - "description": "", - "default": "" - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "wp_pattern_category": { - "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", - "type": "array", + "classes": { + "description": "Class names for the link element of this menu item.", "items": { - "type": "integer" + "type": "string" }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/blocks" - } - ] - } - }, - "/wp/v2/blocks/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "excerpt_length": { - "description": "Override the default excerpt length.", - "type": "integer", - "required": false - }, - "password": { - "description": "The password for the post if it is password protected.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "wp_pattern_sync_status": { - "type": "string", - "description": "", - "default": "", - "enum": [ - "partial", - "unsynced" - ] - }, - "footnotes": { - "type": "string", - "description": "", - "default": "" - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "wp_pattern_category": { - "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/revisions": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "relevance", - "slug", - "include_slugs", - "title" - ], - "required": false - } - } - } - ] - }, - "/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as revisions do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/blocks/(?P\u003Cid\u003E[\\d]+)/autosaves": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "wp_pattern_sync_status": { - "type": "string", - "description": "", - "default": "", - "enum": [ - "partial", - "unsynced" - ] - }, - "footnotes": { - "type": "string", - "description": "", - "default": "" - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "wp_pattern_category": { - "description": "The terms assigned to the object in the wp_pattern_category taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - } - ] - }, - "/wp/v2/blocks/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "id": { - "description": "The ID for the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "relevance", - "slug", - "include_slugs", - "title" - ], - "required": false - } - } - } - ] - }, - "/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "parent": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as revisions do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/templates/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+", - "required": false - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of template.", - "type": "string", - "required": false - }, - "content": { - "description": "Content of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - } - }, - "required": false - }, - "title": { - "description": "Title of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false + "required": false, + "type": "array" }, "description": { - "description": "Description of template.", - "type": "string", - "required": false + "description": "The description of this menu item.", + "required": false, + "type": "string" }, - "status": { - "description": "Status of template.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false + "menu_order": { + "default": 1, + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "required": false, + "type": "string" + }, + "object_id": { + "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, + "required": false, + "type": "integer" }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wp/v2/templates/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { "parent": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "id": { - "description": "The ID for the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/templates": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "wp_id": { - "description": "Limit to the specified post ID.", - "type": "integer", - "required": false - }, - "area": { - "description": "Limit to the specified template part area.", - "type": "string", - "required": false - }, - "post_type": { - "description": "Post type for which to get the templates.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+", - "required": true - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of template.", - "type": "string", - "required": false - }, - "content": { - "default": "", - "description": "Content of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - } - }, - "required": false - }, - "title": { - "default": "", - "description": "Title of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "description": { - "default": "", - "description": "Description of template.", - "type": "string", - "required": false + "default": 0, + "description": "The ID for the parent of the object.", + "minimum": 0, + "required": false, + "type": "integer" }, "status": { "default": "publish", - "description": "Status of template.", - "type": "string", + "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 + "required": false, + "type": "string" }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates" - } - ] - } - }, - "/wp/v2/templates/lookup": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "The slug of the template to get the fallback for", - "type": "string", - "required": true - }, - "is_custom": { - "description": "Indicates if a template is custom or part of the template hierarchy", - "type": "boolean", - "required": false - }, - "template_prefix": { - "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates/lookup" - } - ] - } - }, - "/wp/v2/templates/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", + "target": { + "description": "The target attribute of the link element for this menu item.", "enum": [ - "view", - "embed", - "edit" + "", + "_blank" ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+", - "required": false - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of template.", - "type": "string", - "required": false - }, - "content": { - "description": "Content of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - } - }, - "required": false + "required": false, + "type": "string" }, "title": { - "description": "Title of template.", + "description": "The title for the object.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, "type": [ "object", "string" - ], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false + ] }, - "description": { - "description": "Description of template.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of template.", - "type": "string", + "type": { + "default": "custom", + "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" + "custom", + "post_type", + "post_type_archive", + "taxonomy" ], - "required": false + "required": false, + "type": "string" }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false + "url": { + "description": "The URL to which this menu item points.", + "format": "uri", + "required": false, + "type": "string" }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", "items": { - "type": "integer" + "type": "string" }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "relevance", - "slug", - "include_slugs", - "title" - ], - "required": false + "required": false, + "type": "array" } - } + }, + "methods": [ + "POST" + ] } - ] - }, - "/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "DELETE" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "parent": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as revisions do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/template-parts/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves": { - "namespace": "wp/v2", "methods": [ "GET", "POST" ], + "namespace": "wp/v2" + }, + "/wp/v2/menu-items/(?P[\\d]+)": { "endpoints": [ { + "allow_batch": { + "v1": true + }, + "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 post.", + "required": false, + "type": "integer" + } + }, "methods": [ "GET" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } + ] }, { - "methods": [ - "POST" - ], + "allow_batch": { + "v1": true + }, "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false + "attr_title": { + "description": "Text for the title attribute of the link element for this menu item.", + "required": false, + "type": "string" }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+", - "required": false - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of template.", - "type": "string", - "required": false - }, - "content": { - "description": "Content of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - } + "classes": { + "description": "Class names for the link element of this menu item.", + "items": { + "type": "string" }, - "required": false - }, - "title": { - "description": "Title of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false + "required": false, + "type": "array" }, "description": { - "description": "Description of template.", - "type": "string", - "required": false + "description": "The description of this menu item.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "required": false, + "type": "string" + }, + "object_id": { + "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, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the object.", + "minimum": 0, + "required": false, + "type": "integer" }, "status": { - "description": "Status of template.", - "type": "string", + "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 + "required": false, + "type": "string" }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "required": false + "target": { + "description": "The target attribute of the link element for this menu item.", + "enum": [ + "", + "_blank" + ], + "required": false, + "type": "string" }, - "area": { - "description": "Where the template part is intended for use (header, footer, etc)", - "type": "string", - "required": false + "title": { + "description": "The title for the object.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], + "required": false, + "type": "string" + }, + "url": { + "description": "The URL to which this menu item points.", + "format": "uri", + "required": false, + "type": "string" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" } - } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Whether to bypass Bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] } - ] - }, - "/wp/v2/template-parts/(?P\u003Cparent\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, "methods": [ "GET" - ], + ] + }, + { "args": { + "attr_title": { + "description": "Text for the title attribute of the link element for this menu item.", + "required": false, + "type": "string" + }, + "classes": { + "description": "Class names for the link element of this menu item.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "description": { + "description": "The description of this menu item.", + "required": false, + "type": "string" + }, + "menu_order": { + "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "menus": { + "description": "The terms assigned to the object in the nav_menu taxonomy.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "object": { + "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\".", + "required": false, + "type": "string" + }, + "object_id": { + "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, + "required": false, + "type": "integer" + }, "parent": { - "description": "The ID of a template", - "type": "string", - "required": false + "description": "The ID for the parent of the object.", + "minimum": 0, + "required": false, + "type": "integer" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "target": { + "description": "The target attribute of the link element for this menu item.", + "enum": [ + "", + "_blank" + ], + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the object.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\".", + "enum": [ + "custom", + "post_type", + "post_type_archive", + "taxonomy" + ], + "required": false, + "type": "string" + }, + "url": { + "description": "The URL to which this menu item points.", + "format": "uri", + "required": false, + "type": "string" + }, + "xfn": { + "description": "The XFN relationship expressed in the link of this menu item.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" }, "id": { "description": "The ID for the autosave.", - "type": "integer", - "required": false + "required": false, + "type": "integer" }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/template-parts": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "wp_id": { - "description": "Limit to the specified post ID.", - "type": "integer", - "required": false - }, - "area": { - "description": "Limit to the specified template part area.", - "type": "string", - "required": false - }, - "post_type": { - "description": "Post type for which to get the templates.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+", - "required": true - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of template.", - "type": "string", - "required": false - }, - "content": { - "default": "", - "description": "Content of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - } - }, - "required": false - }, - "title": { - "default": "", - "description": "Title of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "description": { - "default": "", - "description": "Description of template.", - "type": "string", - "required": false - }, - "status": { - "default": "publish", - "description": "Status of template.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "required": false - }, - "area": { - "description": "Where the template part is intended for use (header, footer, etc)", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts" - } - ] - } - }, - "/wp/v2/template-parts/lookup": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "slug": { - "description": "The slug of the template to get the fallback for", - "type": "string", - "required": true - }, - "is_custom": { - "description": "Indicates if a template is custom or part of the template hierarchy", - "type": "boolean", - "required": false - }, - "template_prefix": { - "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts/lookup" - } - ] - } - }, - "/wp/v2/template-parts/(?P\u003Cid\u003E([^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "slug": { - "description": "Unique slug identifying the template.", - "type": "string", - "minLength": 1, - "pattern": "[a-zA-Z0-9_\\%-]+", - "required": false - }, - "theme": { - "description": "Theme identifier for the template.", - "type": "string", - "required": false - }, - "type": { - "description": "Type of template.", - "type": "string", - "required": false - }, - "content": { - "description": "Content of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Content for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit" - ] - }, - "block_version": { - "description": "Version of the content block format used by the template.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - } - }, - "required": false - }, - "title": { - "description": "Title of template.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Title for the template, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the template, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "description": { - "description": "Description of template.", - "type": "string", - "required": false - }, - "status": { - "description": "Status of template.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "author": { - "description": "The ID for the author of the template.", - "type": "integer", - "required": false - }, - "area": { - "description": "Where the template part is intended for use (header, footer, etc)", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/global-styles/(?P\u003Cparent\u003E[\\d]+)/revisions": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "minimum": 1, - "maximum": 100, - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - } - } - } - ] - }, - "/wp/v2/global-styles/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the global styles revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the global styles revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/global-styles/themes/(?P\u003Cstylesheet\u003E[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": false - }, - "args": { - "stylesheet": { - "description": "The theme identifier", - "type": "string", - "required": false - } - } - } - ] - }, - "/wp/v2/global-styles/themes/(?P\u003Cstylesheet\u003E[^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": false - }, - "args": { - "stylesheet": { - "description": "The theme identifier", - "type": "string", - "required": false - } - } - } - ] - }, - "/wp/v2/global-styles/(?P\u003Cid\u003E[\\/\\w-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": false - }, - "args": { - "id": { - "description": "The ID of a template", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": false - }, - "args": { - "styles": { - "description": "Global styles.", - "type": [ - "object" - ], - "required": false - }, - "settings": { - "description": "Global settings.", - "type": [ - "object" - ], - "required": false - }, - "title": { - "description": "Title of the global styles variation.", - "type": [ - "object", - "string" - ], - "properties": { - "raw": { - "description": "Title for the global styles variation, as it exists in the database.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - } - } - } - ] - }, - "/wp/v2/navigation": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", - "default": "date", - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title" - ], - "required": false - }, - "search_columns": { - "default": [], - "description": "Array of column names to be searched.", - "type": "array", - "items": { - "enum": [ - "post_title", - "post_content", - "post_excerpt" - ], - "type": "string" - }, - "required": false - }, - "slug": { - "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to posts assigned one or more statuses.", - "type": "array", - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation" - } - ] - } - }, - "/wp/v2/navigation/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "password": { - "description": "The password for the post if it is password protected.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/revisions": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by object attribute.", - "type": "string", - "default": "date", - "enum": [ - "date", - "id", - "include", - "relevance", - "slug", - "include_slugs", - "title" - ], - "required": false - } - } - } - ] - }, - "/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/revisions/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "parent": { - "description": "The ID for the parent of the revision.", - "type": "integer", - "required": false - }, - "id": { - "description": "Unique identifier for the revision.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as revisions do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/navigation/(?P\u003Cid\u003E[\\d]+)/autosaves": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { "parent": { "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "required": false, + "type": "integer" } - } - }, - { + }, "methods": [ - "POST" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit", - "embed" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - } - } + "GET" + ] } - ] - }, - "/wp/v2/navigation/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", + ], "methods": [ "GET" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "id": { - "description": "The ID for the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] + "namespace": "wp/v2" }, - "/wp/v2/font-families": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", - "default": "id", - "enum": [ - "id", - "include" - ], - "required": false - }, - "slug": { - "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "theme_json_version": { - "description": "Version of the theme.json schema used for the typography settings.", - "type": "integer", - "default": 3, - "minimum": 2, - "maximum": 3, - "required": false - }, - "font_family_settings": { - "description": "font-family declaration in theme.json format, encoded as a string.", - "type": "string", - "required": true - } - } - } - ], + "/wp/v2/menu-locations": { "_links": { "self": [ { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-families" + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-locations" } ] - } - }, - "/wp/v2/font-families/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], + }, "endpoints": [ { - "methods": [ - "GET" - ], "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "theme_json_version": { - "description": "Version of the theme.json schema used for the typography settings.", - "type": "integer", - "default": 3, - "minimum": 2, - "maximum": 3, - "required": false - }, - "font_family_settings": { - "description": "font-family declaration in theme.json format, encoded as a string.", - "type": "string", - "required": true - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/font-families/(?P\u003Cfont_family_id\u003E[\\d]+)/font-faces": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "font_family_id": { - "description": "The ID for the parent font family of the font face.", - "type": "integer", - "required": true - }, - "context": { "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", "enum": [ - "view", + "edit", "embed", - "edit" + "view" ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", - "default": "id", - "enum": [ - "id", - "include" - ], - "required": false + "required": false, + "type": "string" } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "font_family_id": { - "description": "The ID for the parent font family of the font face.", - "type": "integer", - "required": true - }, - "theme_json_version": { - "description": "Version of the theme.json schema used for the typography settings.", - "type": "integer", - "default": 3, - "minimum": 2, - "maximum": 3, - "required": false - }, - "font_face_settings": { - "description": "font-face declaration in theme.json format, encoded as a string.", - "type": "string", - "required": true - } - } - } - ] - }, - "/wp/v2/font-families/(?P\u003Cfont_family_id\u003E[\\d]+)/font-faces/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "font_family_id": { - "description": "The ID for the parent font family of the font face.", - "type": "integer", - "required": true - }, - "id": { - "description": "Unique identifier for the font face.", - "type": "integer", - "required": true - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "font_family_id": { - "description": "The ID for the parent font family of the font face.", - "type": "integer", - "required": true - }, - "id": { - "description": "Unique identifier for the font face.", - "type": "integer", - "required": true - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } - } - ] - }, - "/wp/v2/product": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "after": { - "description": "Limit response to posts published after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_after": { - "description": "Limit response to posts modified after a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "before": { - "description": "Limit response to posts published before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "modified_before": { - "description": "Limit response to posts modified before a given ISO8601 compliant date.", - "type": "string", - "format": "date-time", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", - "default": "date", - "enum": [ - "author", - "date", - "id", - "include", - "modified", - "parent", - "relevance", - "slug", - "include_slugs", - "title", - "popularity", - "rating", - "popularity", - "rating" - ], - "required": false - }, - "search_columns": { - "default": [], - "description": "Array of column names to be searched.", - "type": "array", - "items": { - "enum": [ - "post_title", - "post_content", - "post_excerpt" - ], - "type": "string" - }, - "required": false - }, - "slug": { - "description": "Limit result set to posts with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "status": { - "default": "publish", - "description": "Limit result set to posts assigned one or more statuses.", - "type": "array", - "items": { - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "trash", - "auto-draft", - "inherit", - "request-pending", - "request-confirmed", - "request-failed", - "request-completed", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft", - "any" - ], - "type": "string" - }, - "required": false - }, - "tax_relation": { - "description": "Limit result set based on relationship between multiple taxonomies.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "required": false - }, - "product_cat": { - "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "default": "OR" - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "product_cat_exclude": { - "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - }, - "include_children": { - "description": "Whether to include child terms in the terms limiting the result set.", - "type": "boolean", - "default": false - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "product_tag": { - "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - }, - "operator": { - "description": "Whether items must be assigned all or any of the specified terms.", - "type": "string", - "enum": [ - "AND", - "OR" - ], - "default": "OR" - } - }, - "additionalProperties": false - } - ], - "required": false - }, - "product_tag_exclude": { - "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", - "type": [ - "object", - "array" - ], - "oneOf": [ - { - "title": "Term ID List", - "description": "Match terms with the listed IDs.", - "type": "array", - "items": { - "type": "integer" - } - }, - { - "title": "Term ID Taxonomy Query", - "description": "Perform an advanced term query.", - "type": "object", - "properties": { - "terms": { - "description": "Term IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [] - } - }, - "additionalProperties": false - } - ], - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "product_cat": { - "description": "The terms assigned to the object in the product_cat taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "product_tag": { - "description": "The terms assigned to the object in the product_tag taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product" - } - ] - } - }, - "/wp/v2/product/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { "methods": [ "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "excerpt_length": { - "description": "Override the default excerpt length.", - "type": "integer", - "required": false - }, - "password": { - "description": "The password for the post if it is password protected.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "product_cat": { - "description": "The terms assigned to the object in the product_cat taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "product_tag": { - "description": "The terms assigned to the object in the product_tag taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the post.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - } - } + ] } - ] - }, - "/wp/v2/product/(?P\u003Cid\u003E[\\d]+)/autosaves": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "date": { - "description": "The date the post was published, in the site's time zone.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the post was published, as GMT.", - "type": [ - "string", - "null" - ], - "format": "date-time", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the post unique to its type.", - "type": "string", - "required": false - }, - "status": { - "description": "A named status for the object.", - "type": "string", - "enum": [ - "publish", - "future", - "draft", - "pending", - "private", - "wc-pending", - "wc-processing", - "wc-on-hold", - "wc-completed", - "wc-cancelled", - "wc-refunded", - "wc-failed", - "wc-checkout-draft" - ], - "required": false - }, - "password": { - "description": "A password to protect access to the content and excerpt.", - "type": "string", - "required": false - }, - "title": { - "description": "The title for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Title for the object, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML title for the object, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "content": { - "description": "The content for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit" - ], - "readonly": true - }, - "block_version": { - "description": "Version of the content block format used by the post.", - "type": "integer", - "context": [ - "edit" - ], - "readonly": true - }, - "protected": { - "description": "Whether the content is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "excerpt": { - "description": "The excerpt for the post.", - "type": "object", - "properties": { - "raw": { - "description": "Excerpt for the post, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML excerpt for the post, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - }, - "protected": { - "description": "Whether the excerpt is protected with a password.", - "type": "boolean", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "featured_media": { - "description": "The ID of the featured media for the post.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - }, - "template": { - "description": "The theme file to use to display the post.", - "type": "string", - "required": false - }, - "product_cat": { - "description": "The terms assigned to the object in the product_cat taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "product_tag": { - "description": "The terms assigned to the object in the product_tag taxonomy.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - } - } - } - ] - }, - "/wp/v2/product/(?P\u003Cparent\u003E[\\d]+)/autosaves/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", "methods": [ "GET" ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "location": { + "description": "An alphanumeric identifier for the menu location.", + "required": false, + "type": "string" + } + }, "methods": [ "GET" - ], - "args": { - "parent": { - "description": "The ID for the parent of the autosave.", - "type": "integer", - "required": false - }, - "id": { - "description": "The ID for the autosave.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } + ] } - ] - }, - "/wp/v2/types": { - "namespace": "wp/v2", + ], "methods": [ "GET" ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/types" - } - ] - } - }, - "/wp/v2/types/(?P\u003Ctype\u003E[\\w-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "type": { - "description": "An alphanumeric identifier for the post type.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/statuses": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/statuses" - } - ] - } - }, - "/wp/v2/statuses/(?P\u003Cstatus\u003E[\\w-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "status": { - "description": "An alphanumeric identifier for the status.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/taxonomies": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "type": { - "description": "Limit results to taxonomies associated with a specific post type.", - "type": "string", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/taxonomies" - } - ] - } - }, - "/wp/v2/taxonomies/(?P\u003Ctaxonomy\u003E[\\w-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "taxonomy": { - "description": "An alphanumeric identifier for the taxonomy.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/categories": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by term attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "include_slugs", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide terms not assigned to any posts.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to terms assigned to a specific parent.", - "type": "integer", - "required": false - }, - "post": { - "description": "Limit result set to terms assigned to a specific post.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to terms with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The parent term ID.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/categories" - } - ] - } - }, - "/wp/v2/categories/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The parent term ID.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as terms do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/tags": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by term attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "include_slugs", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide terms not assigned to any posts.", - "type": "boolean", - "default": false, - "required": false - }, - "post": { - "description": "Limit result set to terms assigned to a specific post.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to terms with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/tags" - } - ] - } - }, - "/wp/v2/tags/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as terms do not support binning.", - "required": false - } - } - } - ] + "namespace": "wp/v2" }, "/wp/v2/menus": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by term attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "include_slugs", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide terms not assigned to any posts.", - "type": "boolean", - "default": false, - "required": false - }, - "post": { - "description": "Limit result set to terms assigned to a specific post.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to terms with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - }, - "locations": { - "description": "The locations assigned to the menu.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "auto_add": { - "description": "Whether to automatically add top-level pages to this menu.", - "type": "boolean", - "required": false - } - } - } - ], "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menus" } ] - } - }, - "/wp/v2/menus/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], + }, "endpoints": [ { + "allow_batch": { + "v1": true + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by term attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "post": { + "default": null, + "description": "Limit result set to terms assigned to a specific post.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to terms with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + } + }, "methods": [ "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } + ] }, { - "methods": [ - "POST", - "PUT", - "PATCH" - ], "allow_batch": { "v1": true }, "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false + "auto_add": { + "description": "Whether to automatically add top-level pages to this menu.", + "required": false, + "type": "boolean" }, "description": { "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false + "required": false, + "type": "string" }, "locations": { "description": "The locations assigned to the menu.", - "type": "array", "items": { "type": "string" }, - "required": false + "required": false, + "type": "array" }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "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.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/menus/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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 term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { "auto_add": { "description": "Whether to automatically add top-level pages to this menu.", - "type": "boolean", - "required": false + "required": false, + "type": "boolean" + }, + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + }, + "locations": { + "description": "The locations assigned to the menu.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" } - } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] }, { - "methods": [ - "DELETE" - ], "allow_batch": { "v1": true }, "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, "force": { - "type": "boolean", "default": false, "description": "Required to be true, as terms do not support binning.", - "required": false + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" } - } + }, + "methods": [ + "DELETE" + ] } - ] - }, - "/wp/v2/wp_pattern_category": { - "namespace": "wp/v2", + ], "methods": [ + "DELETE", "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by term attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "include_slugs", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide terms not assigned to any posts.", - "type": "boolean", - "default": false, - "required": false - }, - "post": { - "description": "Limit result set to terms assigned to a specific post.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to terms with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - } + "PATCH", + "POST", + "PUT" ], + "namespace": "wp/v2" + }, + "/wp/v2/navigation": { "_links": { "self": [ { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/wp_pattern_category" + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/navigation" } ] - } - }, - "/wp/v2/wp_pattern_category/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], + }, "endpoints": [ { - "methods": [ - "GET" - ], "allow_batch": { "v1": true }, "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as terms do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/product_cat": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by term attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "include_slugs", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide terms not assigned to any posts.", - "type": "boolean", - "default": false, - "required": false - }, - "parent": { - "description": "Limit result set to terms assigned to a specific parent.", - "type": "integer", - "required": false - }, - "post": { - "description": "Limit result set to terms assigned to a specific post.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to terms with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The parent term ID.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_cat" - } - ] - } - }, - "/wp/v2/product_cat/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "parent": { - "description": "The parent term ID.", - "type": "integer", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as terms do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/product_tag": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "asc", - "enum": [ - "asc", - "desc" - ], - "required": false - }, - "orderby": { - "description": "Sort collection by term attribute.", - "type": "string", - "default": "name", - "enum": [ - "id", - "include", - "name", - "slug", - "include_slugs", - "term_group", - "description", - "count" - ], - "required": false - }, - "hide_empty": { - "description": "Whether to hide terms not assigned to any posts.", - "type": "boolean", - "default": false, - "required": false - }, - "post": { - "description": "Limit result set to terms assigned to a specific post.", - "type": "integer", - "default": null, - "required": false - }, - "slug": { - "description": "Limit result set to terms with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": true - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_tag" - } - ] - } - }, - "/wp/v2/product_tag/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "description": { - "description": "HTML description of the term.", - "type": "string", - "required": false - }, - "name": { - "description": "HTML title for the term.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the term unique to its type.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the term.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as terms do not support binning.", - "required": false - } - } - } - ] - }, - "/wp/v2/users": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "default": [], - "required": false - }, - "offset": { - "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false - }, - "order": { - "default": "asc", - "description": "Order sort attribute ascending or descending.", - "enum": [ - "asc", - "desc" - ], - "type": "string", - "required": false - }, - "orderby": { - "default": "name", - "description": "Sort collection by user attribute.", - "enum": [ - "id", - "include", - "name", - "registered_date", - "slug", - "include_slugs", - "email", - "url" - ], - "type": "string", - "required": false - }, - "slug": { - "description": "Limit result set to users with one or more specific slugs.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "roles": { - "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "capabilities": { - "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "who": { - "description": "Limit result set to users who are considered authors.", - "type": "string", - "enum": [ - "authors" - ], - "required": false - }, - "has_published_posts": { - "description": "Limit result set to users who have published posts.", - "type": [ - "boolean", - "array" - ], - "items": { - "type": "string", - "enum": { - "post": "post", - "page": "page", - "attachment": "attachment", - "nav_menu_item": "nav_menu_item", - "wp_block": "wp_block", - "wp_template": "wp_template", - "wp_template_part": "wp_template_part", - "wp_global_styles": "wp_global_styles", - "wp_navigation": "wp_navigation", - "wp_font_family": "wp_font_family", - "wp_font_face": "wp_font_face", - "product": "product" - } - }, - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "username": { - "description": "Login name for the user.", - "type": "string", - "required": true - }, - "name": { - "description": "Display name for the user.", - "type": "string", - "required": false - }, - "first_name": { - "description": "First name for the user.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Last name for the user.", - "type": "string", - "required": false - }, - "email": { - "description": "The email address for the user.", - "type": "string", - "format": "email", - "required": true - }, - "url": { - "description": "URL of the user.", - "type": "string", - "format": "uri", - "required": false - }, - "description": { - "description": "Description of the user.", - "type": "string", - "required": false - }, - "locale": { - "description": "Locale for the user.", - "type": "string", - "enum": [ - "", - "en_US", - "en_GB", - "fr_BE", - "fr_FR" - ], - "required": false - }, - "nickname": { - "description": "The nickname for the user.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the user.", - "type": "string", - "required": false - }, - "roles": { - "description": "Roles assigned to the user.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "password": { - "description": "Password for the user (never included).", - "type": "string", - "required": true - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "persisted_preferences": { - "type": "object", - "description": "", - "default": [], - "context": [ - "edit" - ], - "properties": { - "_modified": { - "description": "The date and time the preferences were updated.", - "type": "string", - "format": "date-time", - "readonly": false - } - }, - "additionalProperties": true - }, - "woocommerce_launch_your_store_tour_hidden": { - "type": "string", - "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", - "default": "" - }, - "woocommerce_coming_soon_banner_dismissed": { - "type": "string", - "description": "Indicate whether the user has dismissed the coming soon notice or not.", - "default": "" - } - }, - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users" - } - ] - } - }, - "/wp/v2/users/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the user.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the user.", - "type": "integer", - "required": false - }, - "username": { - "description": "Login name for the user.", - "type": "string", - "required": false - }, - "name": { - "description": "Display name for the user.", - "type": "string", - "required": false - }, - "first_name": { - "description": "First name for the user.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Last name for the user.", - "type": "string", - "required": false - }, - "email": { - "description": "The email address for the user.", - "type": "string", - "format": "email", - "required": false - }, - "url": { - "description": "URL of the user.", - "type": "string", - "format": "uri", - "required": false - }, - "description": { - "description": "Description of the user.", - "type": "string", - "required": false - }, - "locale": { - "description": "Locale for the user.", - "type": "string", - "enum": [ - "", - "en_US", - "en_GB", - "fr_BE", - "fr_FR" - ], - "required": false - }, - "nickname": { - "description": "The nickname for the user.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the user.", - "type": "string", - "required": false - }, - "roles": { - "description": "Roles assigned to the user.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "password": { - "description": "Password for the user (never included).", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "persisted_preferences": { - "type": "object", - "description": "", - "default": [], - "context": [ - "edit" - ], - "properties": { - "_modified": { - "description": "The date and time the preferences were updated.", - "type": "string", - "format": "date-time", - "readonly": false - } - }, - "additionalProperties": true - }, - "woocommerce_launch_your_store_tour_hidden": { - "type": "string", - "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", - "default": "" - }, - "woocommerce_coming_soon_banner_dismissed": { - "type": "string", - "description": "Indicate whether the user has dismissed the coming soon notice or not.", - "default": "" - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the user.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as users do not support binning.", - "required": false - }, - "reassign": { - "type": "integer", - "description": "Reassign the deleted user's posts and links to this user ID.", - "required": true - } - } - } - ] - }, - "/wp/v2/users/me": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "username": { - "description": "Login name for the user.", - "type": "string", - "required": false - }, - "name": { - "description": "Display name for the user.", - "type": "string", - "required": false - }, - "first_name": { - "description": "First name for the user.", - "type": "string", - "required": false - }, - "last_name": { - "description": "Last name for the user.", - "type": "string", - "required": false - }, - "email": { - "description": "The email address for the user.", - "type": "string", - "format": "email", - "required": false - }, - "url": { - "description": "URL of the user.", - "type": "string", - "format": "uri", - "required": false - }, - "description": { - "description": "Description of the user.", - "type": "string", - "required": false - }, - "locale": { - "description": "Locale for the user.", - "type": "string", - "enum": [ - "", - "en_US", - "en_GB", - "fr_BE", - "fr_FR" - ], - "required": false - }, - "nickname": { - "description": "The nickname for the user.", - "type": "string", - "required": false - }, - "slug": { - "description": "An alphanumeric identifier for the user.", - "type": "string", - "required": false - }, - "roles": { - "description": "Roles assigned to the user.", - "type": "array", - "items": { - "type": "string" - }, - "required": false - }, - "password": { - "description": "Password for the user (never included).", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": { - "persisted_preferences": { - "type": "object", - "description": "", - "default": [], - "context": [ - "edit" - ], - "properties": { - "_modified": { - "description": "The date and time the preferences were updated.", - "type": "string", - "format": "date-time", - "readonly": false - } - }, - "additionalProperties": true - }, - "woocommerce_launch_your_store_tour_hidden": { - "type": "string", - "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", - "default": "" - }, - "woocommerce_coming_soon_banner_dismissed": { - "type": "string", - "description": "Indicate whether the user has dismissed the coming soon notice or not.", - "default": "" - } - }, - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "force": { - "type": "boolean", - "default": false, - "description": "Required to be true, as users do not support binning.", - "required": false - }, - "reassign": { - "type": "integer", - "description": "Reassign the deleted user's posts and links to this user ID.", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users/me" - } - ] - } - }, - "/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "app_id": { - "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", - "format": "uuid", - "required": false - }, - "name": { - "description": "The name of the application password.", - "type": "string", - "minLength": 1, - "pattern": ".*\\S.*", - "required": true - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": [] - } - ] - }, - "/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords/introspect": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/users/(?P\u003Cuser_id\u003E(?:[\\d]+|me))/application-passwords/(?P\u003Cuuid\u003E[\\w\\-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "app_id": { - "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", - "format": "uuid", - "required": false - }, - "name": { - "description": "The name of the application password.", - "type": "string", - "minLength": 1, - "pattern": ".*\\S.*", - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": [] - } - ] - }, - "/wp/v2/comments": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, "after": { - "description": "Limit response to comments published after a given ISO8601 compliant date.", - "type": "string", + "description": "Limit response to posts published after a given ISO8601 compliant date.", "format": "date-time", - "required": false - }, - "author": { - "description": "Limit result set to comments assigned to specific user IDs. Requires authorisation.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "author_exclude": { - "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorisation.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "author_email": { - "default": null, - "description": "Limit result set to that from a specific author email. Requires authorisation.", - "format": "email", - "type": "string", - "required": false + "required": false, + "type": "string" }, "before": { - "description": "Limit response to comments published before a given ISO8601 compliant date.", - "type": "string", + "description": "Limit response to posts published before a given ISO8601 compliant date.", "format": "date-time", - "required": false + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" }, "exclude": { + "default": [], "description": "Ensure result set excludes specific IDs.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false + "required": false, + "type": "array" }, "include": { + "default": [], "description": "Limit result set to specific IDs.", - "type": "array", "items": { "type": "integer" }, - "default": [], - "required": false + "required": false, + "type": "array" + }, + "modified_after": { + "description": "Limit response to posts modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to posts 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.", - "type": "integer", - "required": false + "required": false, + "type": "integer" }, "order": { - "description": "Order sort attribute ascending or descending.", - "type": "string", "default": "desc", + "description": "Order sort attribute ascending or descending.", "enum": [ "asc", "desc" ], - "required": false + "required": false, + "type": "string" }, "orderby": { - "description": "Sort collection by comment attribute.", - "type": "string", - "default": "date_gmt", + "default": "date", + "description": "Sort collection by post attribute.", "enum": [ + "author", "date", - "date_gmt", "id", "include", - "post", + "include_slugs", + "modified", "parent", - "type" + "relevance", + "slug", + "title" ], - "required": false - }, - "parent": { - "default": [], - "description": "Limit result set to comments of specific parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "parent_exclude": { - "default": [], - "description": "Ensure result set excludes specific parent IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "post": { - "default": [], - "description": "Limit result set to comments assigned to specific post IDs.", - "type": "array", - "items": { - "type": "integer" - }, - "required": false - }, - "status": { - "default": "approve", - "description": "Limit result set to comments assigned a specific status. Requires authorisation.", - "type": "string", - "required": false - }, - "type": { - "default": "comment", - "description": "Limit result set to comments assigned a specific type. Requires authorisation.", - "type": "string", - "required": false - }, - "password": { - "description": "The password for the post if it is password protected.", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST" - ], - "args": { - "author": { - "description": "The ID of the user object, if author was a user.", - "type": "integer", - "required": false - }, - "author_email": { - "description": "Email address for the comment author.", - "type": "string", - "format": "email", - "required": false - }, - "author_ip": { - "description": "IP address for the comment author.", - "type": "string", - "format": "ip", - "required": false - }, - "author_name": { - "description": "Display name for the comment author.", - "type": "string", - "required": false - }, - "author_url": { - "description": "URL for the comment author.", - "type": "string", - "format": "uri", - "required": false - }, - "author_user_agent": { - "description": "User agent for the comment author.", - "type": "string", - "required": false - }, - "content": { - "description": "The content for the comment.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the comment, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the comment, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "date": { - "description": "The date the comment was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the comment was published, as GMT.", - "type": "string", - "format": "date-time", - "required": false - }, - "parent": { - "default": 0, - "description": "The ID for the parent of the comment.", - "type": "integer", - "required": false - }, - "post": { - "default": 0, - "description": "The ID of the associated post object.", - "type": "integer", - "required": false - }, - "status": { - "description": "State of the comment.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/comments" - } - ] - } - }, - "/wp/v2/comments/(?P\u003Cid\u003E[\\d]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "id": { - "description": "Unique identifier for the comment.", - "type": "integer", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "password": { - "description": "The password for the parent post of the comment (if the post is password protected).", - "type": "string", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "id": { - "description": "Unique identifier for the comment.", - "type": "integer", - "required": false - }, - "author": { - "description": "The ID of the user object, if author was a user.", - "type": "integer", - "required": false - }, - "author_email": { - "description": "Email address for the comment author.", - "type": "string", - "format": "email", - "required": false - }, - "author_ip": { - "description": "IP address for the comment author.", - "type": "string", - "format": "ip", - "required": false - }, - "author_name": { - "description": "Display name for the comment author.", - "type": "string", - "required": false - }, - "author_url": { - "description": "URL for the comment author.", - "type": "string", - "format": "uri", - "required": false - }, - "author_user_agent": { - "description": "User agent for the comment author.", - "type": "string", - "required": false - }, - "content": { - "description": "The content for the comment.", - "type": "object", - "properties": { - "raw": { - "description": "Content for the comment, as it exists in the database.", - "type": "string", - "context": [ - "edit" - ] - }, - "rendered": { - "description": "HTML content for the comment, transformed for display.", - "type": "string", - "context": [ - "view", - "edit", - "embed" - ], - "readonly": true - } - }, - "required": false - }, - "date": { - "description": "The date the comment was published, in the site's time zone.", - "type": "string", - "format": "date-time", - "required": false - }, - "date_gmt": { - "description": "The date the comment was published, as GMT.", - "type": "string", - "format": "date-time", - "required": false - }, - "parent": { - "description": "The ID for the parent of the comment.", - "type": "integer", - "required": false - }, - "post": { - "description": "The ID of the associated post object.", - "type": "integer", - "required": false - }, - "status": { - "description": "State of the comment.", - "type": "string", - "required": false - }, - "meta": { - "description": "Meta fields.", - "type": "object", - "properties": [], - "required": false - } - } - }, - { - "methods": [ - "DELETE" - ], - "args": { - "id": { - "description": "Unique identifier for the comment.", - "type": "integer", - "required": false - }, - "force": { - "type": "boolean", - "default": false, - "description": "Whether to bypass Bin and force deletion.", - "required": false - }, - "password": { - "description": "The password for the parent post of the comment (if the post is password protected).", - "type": "string", - "required": false - } - } - } - ] - }, - "/wp/v2/search": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed" - ], - "default": "view", - "required": false + "required": false, + "type": "string" }, "page": { - "description": "Current page of the collection.", - "type": "integer", "default": 1, + "description": "Current page of the collection.", "minimum": 1, - "required": false + "required": false, + "type": "integer" }, "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", "default": 10, - "minimum": 1, + "description": "Maximum number of items to be returned in result set.", "maximum": 100, - "required": false + "minimum": 1, + "required": false, + "type": "integer" }, "search": { "description": "Limit results to those matching a string.", - "type": "string", - "required": false + "required": false, + "type": "string" }, - "type": { - "default": "post", - "description": "Limit results to items of an object type.", - "type": "string", - "enum": [ - "post", - "term", - "post-format" - ], - "required": false - }, - "subtype": { - "default": "any", - "description": "Limit results to items of one or more object subtypes.", - "type": "array", + "search_columns": { + "default": [], + "description": "Array of column names to be searched.", "items": { "enum": [ - "post", - "page", - "product", - "category", - "post_tag", - "product_cat", - "product_tag", - "any" + "post_content", + "post_excerpt", + "post_title" ], "type": "string" }, - "required": false + "required": false, + "type": "array" }, - "exclude": { - "description": "Ensure result set excludes specific IDs.", - "type": "array", + "slug": { + "description": "Limit result set to posts with one or more specific slugs.", "items": { - "type": "integer" + "type": "string" }, - "default": [], - "required": false + "required": false, + "type": "array" }, - "include": { - "description": "Limit result set to specific IDs.", - "type": "array", + "status": { + "default": "publish", + "description": "Limit result set to posts assigned one or more statuses.", "items": { - "type": "integer" + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" }, - "default": [], - "required": false + "required": false, + "type": "array" } - } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit", + "embed" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] } ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/search" - } - ] - } - }, - "/wp/v2/block-renderer/(?P\u003Cname\u003E[a-z0-9-]+/[a-z0-9-]+)": { - "namespace": "wp/v2", "methods": [ "GET", "POST" ], - "endpoints": [ - { - "methods": [ - "GET", - "POST" - ], - "args": { - "name": { - "description": "Unique registered name for the block.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "edit" - ], - "default": "view", - "required": false - }, - "attributes": { - "description": "Attributes for the block.", - "type": "object", - "default": [], - "required": false - }, - "post_id": { - "description": "ID of the post context.", - "type": "integer", - "required": false - } - } - } - ] + "namespace": "wp/v2" }, - "/wp/v2/block-types": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], + "/wp/v2/navigation/(?P[\\d]+)": { "endpoints": [ { - "methods": [ - "GET" - ], + "allow_batch": { + "v1": true + }, "args": { "context": { + "default": "view", "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", "enum": [ - "view", + "edit", "embed", - "edit" + "view" ], - "default": "view", - "required": false + "required": false, + "type": "string" }, - "namespace": { - "description": "Block namespace.", - "type": "string", - "required": false + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "password": { + "description": "The password for the post if it is password protected.", + "required": false, + "type": "string" } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-types" - } - ] - } - }, - "/wp/v2/block-types/(?P\u003Cnamespace\u003E[a-zA-Z0-9_-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { + }, "methods": [ "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "namespace": { - "description": "Block namespace.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wp/v2/block-types/(?P\u003Cnamespace\u003E[a-zA-Z0-9_-]+)/(?P\u003Cname\u003E[a-zA-Z0-9_-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "name": { - "description": "Block name.", - "type": "string", - "required": false - }, - "namespace": { - "description": "Block namespace.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp/v2/settings": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] + ] }, { - "methods": [ - "POST", - "PUT", - "PATCH" - ], + "allow_batch": { + "v1": true + }, "args": { - "title": { - "title": "Title", - "description": "Site title.", - "type": "string", - "required": false - }, - "description": { - "title": "Tagline", - "description": "Site tagline.", - "type": "string", - "required": false - }, - "url": { - "title": "", - "description": "Site URL.", - "type": "string", - "format": "uri", - "required": false - }, - "email": { - "title": "", - "description": "This address is used for admin purposes, like new user notification.", - "type": "string", - "format": "email", - "required": false - }, - "timezone": { - "title": "", - "description": "A city in the same timezone as you.", - "type": "string", - "required": false - }, - "date_format": { - "title": "", - "description": "A date format for all date strings.", - "type": "string", - "required": false - }, - "time_format": { - "title": "", - "description": "A time format for all time strings.", - "type": "string", - "required": false - }, - "start_of_week": { - "title": "", - "description": "A day number of the week that the week should start on.", - "type": "integer", - "required": false - }, - "language": { - "title": "", - "description": "WordPress locale code.", - "type": "string", - "required": false - }, - "use_smilies": { - "title": "", - "description": "Convert emoticons like :-) and :-P to graphics on display.", - "type": "boolean", - "required": false - }, - "default_category": { - "title": "", - "description": "Default post category.", - "type": "integer", - "required": false - }, - "default_post_format": { - "title": "", - "description": "Default post format.", - "type": "string", - "required": false - }, - "posts_per_page": { - "title": "Maximum posts per page", - "description": "Blog pages show at most.", - "type": "integer", - "required": false - }, - "show_on_front": { - "title": "Show on front", - "description": "What to show on the front page", - "type": "string", - "required": false - }, - "page_on_front": { - "title": "Page on front", - "description": "The ID of the page that should be displayed on the front page", - "type": "integer", - "required": false - }, - "page_for_posts": { - "title": "", - "description": "The ID of the page that should display the latest posts", - "type": "integer", - "required": false - }, - "default_ping_status": { - "title": "", - "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "default_comment_status": { - "title": "Allow comments on new posts", - "description": "Allow people to submit comments on new posts.", - "type": "string", - "enum": [ - "open", - "closed" - ], - "required": false - }, - "site_logo": { - "title": "Logo", - "description": "Site logo.", - "type": "integer", - "required": false - }, - "site_icon": { - "title": "Icon", - "description": "Site icon.", - "type": "integer", - "required": false - }, - "pickup_location_settings": { - "title": "", - "description": "WooCommerce Local Pickup Method Settings", - "type": "object", + "content": { + "description": "The content for the post.", "properties": { - "enabled": { - "description": "If enabled, this method will appear on the block based checkout.", - "type": "string", - "enum": [ - "yes", - "no" - ] + "block_version": { + "context": [ + "edit", + "embed" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" }, - "title": { - "description": "This controls the title which the user sees during checkout.", + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Content for the post, as it exists in the database.", "type": "string" }, - "tax_status": { - "description": "If a cost is defined, this controls if taxes are applied to that cost.", - "type": "string", - "enum": [ - "taxable", - "none" - ] - }, - "cost": { - "description": "Optional cost to charge for local pickup.", + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, "type": "string" } }, - "additionalProperties": false, - "required": false + "required": false, + "type": "object" }, - "pickup_locations": { - "title": "", - "description": "WooCommerce Local Pickup Locations", - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "address": { - "type": "object", - "properties": { - "address_1": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "country": { - "type": "string" - } - }, - "additionalProperties": false - }, - "details": { - "type": "string" - }, - "enabled": { - "type": "boolean" - } + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" }, - "additionalProperties": false + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } }, - "required": false + "required": false, + "type": "object" } - } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Whether to bypass Bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] } ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/settings" - } - ] - } + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" }, - "/wp/v2/themes": { - "namespace": "wp/v2", + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit", + "embed" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit", + "embed" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID for the autosave.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "include_slugs", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, "methods": [ "GET" - ], + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as revisions do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/pages": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pages" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "after": { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "author": { + "default": [], + "description": "Limit result set to posts assigned to specific authors.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "author_exclude": { + "default": [], + "description": "Ensure result set excludes posts assigned to specific authors.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to posts 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", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "menu_order": { + "description": "Limit result set to posts with a specific menu_order value.", + "required": false, + "type": "integer" + }, + "modified_after": { + "description": "Limit response to posts modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to posts 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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by post attribute.", + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "menu_order", + "modified", + "parent", + "relevance", + "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 items with 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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "search_columns": { + "default": [], + "description": "Array of column names to be searched.", + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "Limit result set to posts with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, "status": { - "description": "Limit result set to themes assigned one or more statuses.", - "type": "array", + "default": "publish", + "description": "Limit result set to posts assigned one or more statuses.", + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "author": { + "description": "The ID for the author of the post.", + "required": false, + "type": "integer" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "The order of the post in relation to other posts.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/pages/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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" + }, + "excerpt_length": { + "description": "Override the default excerpt length.", + "required": false, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "password": { + "description": "The password for the post if it is password protected.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "author": { + "description": "The ID for the author of the post.", + "required": false, + "type": "integer" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "The order of the post in relation to other posts.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Whether to bypass Bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "author": { + "description": "The ID for the author of the post.", + "required": false, + "type": "integer" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "menu_order": { + "description": "The order of the post in relation to other posts.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the object.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID for the autosave.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "include_slugs", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as revisions do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/pattern-directory/patterns": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pattern-directory/patterns" + } + ] + }, + "endpoints": [ + { + "args": { + "category": { + "description": "Limit results to those matching a category ID.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "keyword": { + "description": "Limit results to those matching a keyword ID.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by post attribute.", + "enum": [ + "author", + "date", + "favorite_count", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 100, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "minLength": 1, + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit results to those matching a pattern (slug).", + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/plugins": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/plugins" + } + ] + }, + "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" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "status": { + "description": "Limits results to plugins with the given status.", "items": { "enum": [ "active", @@ -97983,1243 +92393,6857 @@ ], "type": "string" }, - "required": false + "required": false, + "type": "array" } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/themes" - } - ] - } - }, - "/wp/v2/themes/(?P\u003Cstylesheet\u003E[^\\/:\u003C\u003E\\*\\?\"\\|]+(?:\\/[^\\/:\u003C\u003E\\*\\?\"\\|]+)?)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { + }, "methods": [ "GET" - ], + ] + }, + { "args": { - "stylesheet": { - "description": "The theme's style sheet. This uniquely identifies the theme.", - "type": "string", - "required": false + "slug": { + "description": "WordPress.org plugin directory slug.", + "pattern": "[\\w\\-]+", + "required": true, + "type": "string" + }, + "status": { + "default": "inactive", + "description": "The plugin activation status.", + "enum": [ + "active", + "inactive" + ], + "required": false, + "type": "string" } - } + }, + "methods": [ + "POST" + ] } - ] - }, - "/wp/v2/plugins": { - "namespace": "wp/v2", + ], "methods": [ "GET", "POST" ], + "namespace": "wp/v2" + }, + "/wp/v2/plugins/(?P[^.\\/]+(?:\\/[^.\\/]+)?)": { "endpoints": [ { - "methods": [ - "GET" - ], "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "required": false - }, - "status": { - "description": "Limits results to plugins with the given status.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "inactive", - "active" - ] - }, - "required": false + "plugin": { + "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] }, { - "methods": [ - "POST" - ], "args": { - "slug": { - "type": "string", - "description": "WordPress.org plugin directory slug.", - "pattern": "[\\w\\-]+", - "required": true + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "plugin": { + "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", + "required": false, + "type": "string" }, "status": { "description": "The plugin activation status.", - "type": "string", "enum": [ - "inactive", - "active" + "active", + "inactive" ], - "default": "inactive", - "required": false + "required": false, + "type": "string" } - } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "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" + }, + "plugin": { + "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] } ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/posts": { "_links": { "self": [ { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/plugins" + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/posts" } ] - } - }, - "/wp/v2/plugins/(?P\u003Cplugin\u003E[^.\\/]+(?:\\/[^.\\/]+)?)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], + }, "endpoints": [ { - "methods": [ - "GET" - ], + "allow_batch": { + "v1": true + }, "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "after": { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" }, - "plugin": { - "type": "string", - "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", - "required": false - } - } - }, - { - "methods": [ - "POST", - "PUT", - "PATCH" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "author": { + "default": [], + "description": "Limit result set to posts assigned to specific authors.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" }, - "plugin": { - "type": "string", - "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", - "required": false + "author_exclude": { + "default": [], + "description": "Ensure result set excludes posts assigned to specific authors.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "before": { + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "categories": { + "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "categories_exclude": { + "description": "Limit result set to items, except those with specific terms assigned in the categories taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "modified_after": { + "description": "Limit response to posts modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to posts 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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by post attribute.", + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "search_columns": { + "default": [], + "description": "Array of column names to be searched.", + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "Limit result set to posts with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" }, "status": { - "description": "The plugin activation status.", - "type": "string", - "enum": [ - "inactive", - "active" + "default": "publish", + "description": "Limit result set to posts assigned one or more statuses.", + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "sticky": { + "description": "Limit result set to items that are sticky.", + "required": false, + "type": "boolean" + }, + "tags": { + "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } ], - "required": false + "required": false, + "type": [ + "array", + "object" + ] + }, + "tags_exclude": { + "description": "Limit result set to items, except those with specific terms assigned in the tags taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "tax_relation": { + "description": "Limit result set based on relationship between multiple taxonomies.", + "enum": [ + "AND", + "OR" + ], + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] }, { + "allow_batch": { + "v1": true + }, + "args": { + "author": { + "description": "The ID for the author of the post.", + "required": false, + "type": "integer" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "sticky": { + "description": "Whether or not the post should be treated as sticky.", + "required": false, + "type": "boolean" + }, + "tags": { + "description": "The terms assigned to the object in the post_tag taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, "methods": [ - "DELETE" - ], + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/posts/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" }, - "plugin": { - "type": "string", - "pattern": "[^.\\/]+(?:\\/[^.\\/]+)?", - "required": false + "excerpt_length": { + "description": "Override the default excerpt length.", + "required": false, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "password": { + "description": "The password for the post if it is password protected.", + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "author": { + "description": "The ID for the author of the post.", + "required": false, + "type": "integer" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "sticky": { + "description": "Whether or not the post should be treated as sticky.", + "required": false, + "type": "boolean" + }, + "tags": { + "description": "The terms assigned to the object in the post_tag taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Whether to bypass Bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] } - ] + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" }, - "/wp/v2/sidebars": { - "namespace": "wp/v2", + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "author": { + "description": "The ID for the author of the post.", + "required": false, + "type": "integer" + }, + "categories": { + "description": "The terms assigned to the object in the category taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "comment_status": { + "description": "Whether or not comments are open on the post.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "format": { + "description": "The format for the post.", + "enum": [ + "aside", + "audio", + "chat", + "gallery", + "image", + "link", + "quote", + "standard", + "status", + "video" + ], + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "footnotes": { + "default": "", + "description": "", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "ping_status": { + "description": "Whether or not the post can be pinged.", + "enum": [ + "closed", + "open" + ], + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "sticky": { + "description": "Whether or not the post should be treated as sticky.", + "required": false, + "type": "boolean" + }, + "tags": { + "description": "The terms assigned to the object in the post_tag taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID for the autosave.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], + "namespace": "wp/v2" + }, + "/wp/v2/posts/(?P[\\d]+)/revisions": { "endpoints": [ { - "methods": [ - "GET" - ], "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "include_slugs", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] } ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as revisions do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the revision.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/product": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "after": { + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "before": { + "description": "Limit response to posts 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", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "modified_after": { + "description": "Limit response to posts modified after a given ISO8601 compliant date.", + "format": "date-time", + "required": false, + "type": "string" + }, + "modified_before": { + "description": "Limit response to posts 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" + }, + "order": { + "default": "desc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "date", + "description": "Sort collection by post attribute.", + "enum": [ + "author", + "date", + "id", + "include", + "include_slugs", + "modified", + "parent", + "popularity", + "popularity", + "rating", + "rating", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "product_cat": { + "description": "Limit result set to items with specific terms assigned in the product_cat taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "product_cat_exclude": { + "description": "Limit result set to items, except those with specific terms assigned in the product_cat taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "include_children": { + "default": false, + "description": "Whether to include child terms in the terms limiting the result set.", + "type": "boolean" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "product_tag": { + "description": "Limit result set to items with specific terms assigned in the product_tag taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "operator": { + "default": "OR", + "description": "Whether items must be assigned all or any of the specified terms.", + "enum": [ + "AND", + "OR" + ], + "type": "string" + }, + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "product_tag_exclude": { + "description": "Limit result set to items, except those with specific terms assigned in the product_tag taxonomy.", + "oneOf": [ + { + "description": "Match terms with the listed IDs.", + "items": { + "type": "integer" + }, + "title": "Term ID List", + "type": "array" + }, + { + "additionalProperties": false, + "description": "Perform an advanced term query.", + "properties": { + "terms": { + "default": [], + "description": "Term IDs.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "title": "Term ID Taxonomy Query", + "type": "object" + } + ], + "required": false, + "type": [ + "array", + "object" + ] + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "search_columns": { + "default": [], + "description": "Array of column names to be searched.", + "items": { + "enum": [ + "post_content", + "post_excerpt", + "post_title" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "Limit result set to posts with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "status": { + "default": "publish", + "description": "Limit result set to posts assigned one or more statuses.", + "items": { + "enum": [ + "any", + "auto-draft", + "draft", + "future", + "inherit", + "pending", + "private", + "publish", + "request-completed", + "request-confirmed", + "request-failed", + "request-pending", + "trash", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "tax_relation": { + "description": "Limit result set based on relationship between multiple taxonomies.", + "enum": [ + "AND", + "OR" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/product/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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" + }, + "excerpt_length": { + "description": "Override the default excerpt length.", + "required": false, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "password": { + "description": "The password for the post if it is password protected.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Whether to bypass Bin and force deletion.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the post.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "content": { + "description": "The content for the post.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the post.", + "readonly": true, + "type": "integer" + }, + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the content is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Content for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "view" + ], + "description": "HTML content for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "date": { + "description": "The date the post was published, in the site's time zone.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "date_gmt": { + "description": "The date the post was published, as GMT.", + "format": "date-time", + "required": false, + "type": [ + "null", + "string" + ] + }, + "excerpt": { + "description": "The excerpt for the post.", + "properties": { + "protected": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Whether the excerpt is protected with a password.", + "readonly": true, + "type": "boolean" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Excerpt for the post, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML excerpt for the post, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "featured_media": { + "description": "The ID of the featured media for the post.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + }, + "password": { + "description": "A password to protect access to the content and excerpt.", + "required": false, + "type": "string" + }, + "product_cat": { + "description": "The terms assigned to the object in the product_cat taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "product_tag": { + "description": "The terms assigned to the object in the product_tag taxonomy.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the post unique to its type.", + "required": false, + "type": "string" + }, + "status": { + "description": "A named status for the object.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "template": { + "description": "The theme file to use to display the post.", + "required": false, + "type": "string" + }, + "title": { + "description": "The title for the post.", + "properties": { + "raw": { + "context": [ + "edit" + ], + "description": "Title for the object, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the object, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID for the autosave.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID for the parent of the autosave.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/product_cat": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_cat" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by term attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "Limit result set to terms assigned to a specific parent.", + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "post": { + "default": null, + "description": "Limit result set to terms assigned to a specific post.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to terms with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": true, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/product_cat/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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 term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": false, + "type": "string" + }, + "parent": { + "description": "The parent term ID.", + "required": false, + "type": "integer" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Required to be true, as terms do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/product_tag": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/product_tag" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by term attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "post": { + "default": null, + "description": "Limit result set to terms assigned to a specific post.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to terms with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "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.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/product_tag/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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 term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Required to be true, as terms do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/search": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/search" + } + ] + }, + "endpoints": [ + { + "args": { + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "subtype": { + "default": "any", + "description": "Limit results to items of one or more object subtypes.", + "items": { + "enum": [ + "any", + "category", + "page", + "post", + "post_tag", + "product", + "product_cat", + "product_tag" + ], + "type": "string" + }, + "required": false, + "type": "array" + }, + "type": { + "default": "post", + "description": "Limit results to items of an object type.", + "enum": [ + "post", + "post-format", + "term" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/settings": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/settings" + } + ] + }, + "endpoints": [ + { + "args": [], + "methods": [ + "GET" + ] + }, + { + "args": { + "date_format": { + "description": "A date format for all date strings.", + "required": false, + "title": "", + "type": "string" + }, + "default_category": { + "description": "Default post category.", + "required": false, + "title": "", + "type": "integer" + }, + "default_comment_status": { + "description": "Allow people to submit comments on new posts.", + "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": [ + "closed", + "open" + ], + "required": false, + "title": "", + "type": "string" + }, + "default_post_format": { + "description": "Default post format.", + "required": false, + "title": "", + "type": "string" + }, + "description": { + "description": "Site tagline.", + "required": false, + "title": "Tagline", + "type": "string" + }, + "email": { + "description": "This address is used for admin purposes, like new user notification.", + "format": "email", + "required": false, + "title": "", + "type": "string" + }, + "language": { + "description": "WordPress locale code.", + "required": false, + "title": "", + "type": "string" + }, + "page_for_posts": { + "description": "The ID of the page that should display the latest posts", + "required": false, + "title": "", + "type": "integer" + }, + "page_on_front": { + "description": "The ID of the page that should be displayed on the front page", + "required": false, + "title": "Page on front", + "type": "integer" + }, + "pickup_location_settings": { + "additionalProperties": false, + "description": "WooCommerce Local Pickup Method Settings", + "properties": { + "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": [ + "no", + "yes" + ], + "type": "string" + }, + "tax_status": { + "description": "If a cost is defined, this controls if taxes are applied to that cost.", + "enum": [ + "none", + "taxable" + ], + "type": "string" + }, + "title": { + "description": "This controls the title which the user sees during checkout.", + "type": "string" + } + }, + "required": false, + "title": "", + "type": "object" + }, + "pickup_locations": { + "description": "WooCommerce Local Pickup Locations", + "items": { + "additionalProperties": false, + "properties": { + "address": { + "additionalProperties": false, + "properties": { + "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" + } + }, + "type": "object" + }, + "required": false, + "title": "", + "type": "array" + }, + "posts_per_page": { + "description": "Blog pages show at most.", + "required": false, + "title": "Maximum posts per page", + "type": "integer" + }, + "show_on_front": { + "description": "What to show on the front page", + "required": false, + "title": "Show on front", + "type": "string" + }, + "site_icon": { + "description": "Site icon.", + "required": false, + "title": "Icon", + "type": "integer" + }, + "site_logo": { + "description": "Site logo.", + "required": false, + "title": "Logo", + "type": "integer" + }, + "start_of_week": { + "description": "A day number of the week that the week should start on.", + "required": false, + "title": "", + "type": "integer" + }, + "time_format": { + "description": "A time format for all time strings.", + "required": false, + "title": "", + "type": "string" + }, + "timezone": { + "description": "A city in the same timezone as you.", + "required": false, + "title": "", + "type": "string" + }, + "title": { + "description": "Site title.", + "required": false, + "title": "Title", + "type": "string" + }, + "url": { + "description": "Site URL.", + "format": "uri", + "required": false, + "title": "", + "type": "string" + }, + "use_smilies": { + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "required": false, + "title": "", + "type": "boolean" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + } + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/sidebars": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/sidebars" } ] - } - }, - "/wp/v2/sidebars/(?P\u003Cid\u003E[\\w-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH" - ], + }, "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" + } + }, "methods": [ "GET" - ], + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/sidebars/(?P[\\w-]+)": { + "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": "The ID of a registered sidebar", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] }, { - "methods": [ - "POST", - "PUT", - "PATCH" - ], "args": { "widgets": { "description": "Nested widgets.", - "type": "array", "items": { "type": [ "object", "string" ] }, - "required": false + "required": false, + "type": "array" } - } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] } - ] + ], + "methods": [ + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" }, - "/wp/v2/widget-types": { - "namespace": "wp/v2", + "/wp/v2/statuses": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/statuses" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], + "namespace": "wp/v2" + }, + "/wp/v2/statuses/(?P[\\w-]+)": { "endpoints": [ { - "methods": [ - "GET" - ], "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "status": { + "description": "An alphanumeric identifier for the status.", + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] } ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/tags": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/tags" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "hide_empty": { + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "required": false, + "type": "boolean" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by term attribute.", + "enum": [ + "count", + "description", + "id", + "include", + "include_slugs", + "name", + "slug", + "term_group" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "post": { + "default": null, + "description": "Limit result set to terms assigned to a specific post.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to terms with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "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.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/tags/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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 term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Required to be true, as terms do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/taxonomies": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/taxonomies" + } + ] + }, + "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" + }, + "type": { + "description": "Limit results to taxonomies associated with a specific post type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/taxonomies/(?P[\\w-]+)": { + "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" + }, + "taxonomy": { + "description": "An alphanumeric identifier for the taxonomy.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/template-parts": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts" + } + ] + }, + "endpoints": [ + { + "args": { + "area": { + "description": "Limit to the specified template part area.", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "post_type": { + "description": "Post type for which to get the templates.", + "required": false, + "type": "string" + }, + "wp_id": { + "description": "Limit to the specified post ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "area": { + "description": "Where the template part is intended for use (header, footer, etc)", + "required": false, + "type": "string" + }, + "author": { + "description": "The ID for the author of the template.", + "required": false, + "type": "integer" + }, + "content": { + "default": "", + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "description": { + "default": "", + "description": "Description of template.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": true, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "required": false, + "type": "string" + }, + "title": { + "default": "", + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "area": { + "description": "Where the template part is intended for use (header, footer, etc)", + "required": false, + "type": "string" + }, + "author": { + "description": "The ID for the author of the template.", + "required": false, + "type": "integer" + }, + "content": { + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "required": false, + "type": "string" + }, + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "required": false, + "type": "string" + }, + "title": { + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "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": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "area": { + "description": "Where the template part is intended for use (header, footer, etc)", + "required": false, + "type": "string" + }, + "author": { + "description": "The ID for the author of the template.", + "required": false, + "type": "integer" + }, + "content": { + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "required": false, + "type": "string" + }, + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "required": false, + "type": "string" + }, + "title": { + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID for the autosave.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "include_slugs", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as revisions do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/template-parts/lookup": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/template-parts/lookup" + } + ] + }, + "endpoints": [ + { + "args": { + "is_custom": { + "description": "Indicates if a template is custom or part of the template hierarchy", + "required": false, + "type": "boolean" + }, + "slug": { + "description": "The slug of the template to get the fallback for", + "required": true, + "type": "string" + }, + "template_prefix": { + "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/templates": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates" + } + ] + }, + "endpoints": [ + { + "args": { + "area": { + "description": "Limit to the specified template part area.", + "required": false, + "type": "string" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "post_type": { + "description": "Post type for which to get the templates.", + "required": false, + "type": "string" + }, + "wp_id": { + "description": "Limit to the specified post ID.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "author": { + "description": "The ID for the author of the template.", + "required": false, + "type": "integer" + }, + "content": { + "default": "", + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "description": { + "default": "", + "description": "Description of template.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": true, + "type": "string" + }, + "status": { + "default": "publish", + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "required": false, + "type": "string" + }, + "title": { + "default": "", + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/templates/(?P([^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)[\\/\\w%-]+)": { + "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": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "author": { + "description": "The ID for the author of the template.", + "required": false, + "type": "integer" + }, + "content": { + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "required": false, + "type": "string" + }, + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "required": false, + "type": "string" + }, + "title": { + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "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": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "author": { + "description": "The ID for the author of the template.", + "required": false, + "type": "integer" + }, + "content": { + "description": "Content of template.", + "properties": { + "block_version": { + "context": [ + "edit" + ], + "description": "Version of the content block format used by the template.", + "readonly": true, + "type": "integer" + }, + "raw": { + "context": [ + "edit", + "view" + ], + "description": "Content for the template, as it exists in the database.", + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "description": { + "description": "Description of template.", + "required": false, + "type": "string" + }, + "id": { + "description": "The ID of a template", + "required": false, + "type": "string" + }, + "slug": { + "description": "Unique slug identifying the template.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_\\%-]+", + "required": false, + "type": "string" + }, + "status": { + "description": "Status of template.", + "enum": [ + "draft", + "future", + "pending", + "private", + "publish", + "wc-cancelled", + "wc-checkout-draft", + "wc-completed", + "wc-failed", + "wc-on-hold", + "wc-pending", + "wc-processing", + "wc-refunded" + ], + "required": false, + "type": "string" + }, + "theme": { + "description": "Theme identifier for the template.", + "required": false, + "type": "string" + }, + "title": { + "description": "Title of template.", + "properties": { + "raw": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "Title for the template, as it exists in the database.", + "type": "string" + }, + "rendered": { + "context": [ + "edit", + "embed", + "view" + ], + "description": "HTML title for the template, transformed for display.", + "readonly": true, + "type": "string" + } + }, + "required": false, + "type": [ + "object", + "string" + ] + }, + "type": { + "description": "Type of template.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The ID for the autosave.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "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", + "include_slugs", + "relevance", + "slug", + "title" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + }, + "per_page": { + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as revisions do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the revision.", + "required": false, + "type": "integer" + }, + "parent": { + "description": "The ID of a template", + "required": false, + "type": "string" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/templates/lookup": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/templates/lookup" + } + ] + }, + "endpoints": [ + { + "args": { + "is_custom": { + "description": "Indicates if a template is custom or part of the template hierarchy", + "required": false, + "type": "boolean" + }, + "slug": { + "description": "The slug of the template to get the fallback for", + "required": true, + "type": "string" + }, + "template_prefix": { + "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/themes": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/themes" + } + ] + }, + "endpoints": [ + { + "args": { + "status": { + "description": "Limit result set to themes assigned one or more statuses.", + "items": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "required": false, + "type": "array" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/themes/(?P[^\\/:<>\\*\\?\"\\|]+(?:\\/[^\\/:<>\\*\\?\"\\|]+)?)": { + "endpoints": [ + { + "args": { + "stylesheet": { + "description": "The theme's style sheet. This uniquely identifies the theme.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/types": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/types" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/types/(?P[\\w-]+)": { + "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" + }, + "type": { + "description": "An alphanumeric identifier for the post type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/users": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users" + } + ] + }, + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "args": { + "capabilities": { + "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "context": { + "default": "view", + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "has_published_posts": { + "description": "Limit result set to users who have published posts.", + "items": { + "enum": { + "attachment": "attachment", + "nav_menu_item": "nav_menu_item", + "page": "page", + "post": "post", + "product": "product", + "wp_block": "wp_block", + "wp_font_face": "wp_font_face", + "wp_font_family": "wp_font_family", + "wp_global_styles": "wp_global_styles", + "wp_navigation": "wp_navigation", + "wp_template": "wp_template", + "wp_template_part": "wp_template_part" + }, + "type": "string" + }, + "required": false, + "type": [ + "array", + "boolean" + ] + }, + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" + }, + "offset": { + "description": "Offset the result set by a specific number of items.", + "required": false, + "type": "integer" + }, + "order": { + "default": "asc", + "description": "Order sort attribute ascending or descending.", + "enum": [ + "asc", + "desc" + ], + "required": false, + "type": "string" + }, + "orderby": { + "default": "name", + "description": "Sort collection by user attribute.", + "enum": [ + "email", + "id", + "include", + "include_slugs", + "name", + "registered_date", + "slug", + "url" + ], + "required": false, + "type": "string" + }, + "page": { + "default": 1, + "description": "Current page of the collection.", + "minimum": 1, + "required": false, + "type": "integer" + }, + "per_page": { + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "maximum": 100, + "minimum": 1, + "required": false, + "type": "integer" + }, + "roles": { + "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to users with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "who": { + "description": "Limit result set to users who are considered authors.", + "enum": [ + "authors" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "Description of the user.", + "required": false, + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "format": "email", + "required": true, + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "required": false, + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "persisted_preferences": { + "additionalProperties": true, + "context": [ + "edit" + ], + "default": [], + "description": "", + "properties": { + "_modified": { + "description": "The date and time the preferences were updated.", + "format": "date-time", + "readonly": false, + "type": "string" + } + }, + "type": "object" + }, + "woocommerce_coming_soon_banner_dismissed": { + "default": "", + "description": "Indicate whether the user has dismissed the coming soon notice or not.", + "type": "string" + }, + "woocommerce_launch_your_store_tour_hidden": { + "default": "", + "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "required": false, + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "required": false, + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "required": true, + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "required": false, + "type": "string" + }, + "url": { + "description": "URL of the user.", + "format": "uri", + "required": false, + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/users/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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 user.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "Description of the user.", + "required": false, + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the user.", + "required": false, + "type": "integer" + }, + "last_name": { + "description": "Last name for the user.", + "required": false, + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "persisted_preferences": { + "additionalProperties": true, + "context": [ + "edit" + ], + "default": [], + "description": "", + "properties": { + "_modified": { + "description": "The date and time the preferences were updated.", + "format": "date-time", + "readonly": false, + "type": "string" + } + }, + "type": "object" + }, + "woocommerce_coming_soon_banner_dismissed": { + "default": "", + "description": "Indicate whether the user has dismissed the coming soon notice or not.", + "type": "string" + }, + "woocommerce_launch_your_store_tour_hidden": { + "default": "", + "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "required": false, + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "required": false, + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "required": false, + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "required": false, + "type": "string" + }, + "url": { + "description": "URL of the user.", + "format": "uri", + "required": false, + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Required to be true, as users do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the user.", + "required": false, + "type": "integer" + }, + "reassign": { + "description": "Reassign the deleted user's posts and links to this user ID.", + "required": true, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "app_id": { + "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", + "required": false, + "type": "string" + }, + "name": { + "description": "The name of the application password.", + "minLength": 1, + "pattern": ".*\\S.*", + "required": true, + "type": "string" + } + }, + "methods": [ + "POST" + ] + }, + { + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "app_id": { + "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", + "required": false, + "type": "string" + }, + "name": { + "description": "The name of the application password.", + "minLength": 1, + "pattern": ".*\\S.*", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": [], + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + } + }, + "methods": [ + "GET" + ] + } + ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/users/me": { + "_links": { + "self": [ + { + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/users/me" + } + ] + }, + "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" + } + }, + "methods": [ + "GET" + ] + }, + { + "args": { + "description": { + "description": "Description of the user.", + "required": false, + "type": "string" + }, + "email": { + "description": "The email address for the user.", + "format": "email", + "required": false, + "type": "string" + }, + "first_name": { + "description": "First name for the user.", + "required": false, + "type": "string" + }, + "last_name": { + "description": "Last name for the user.", + "required": false, + "type": "string" + }, + "locale": { + "description": "Locale for the user.", + "enum": [ + "", + "en_GB", + "en_US", + "fr_BE", + "fr_FR" + ], + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": { + "persisted_preferences": { + "additionalProperties": true, + "context": [ + "edit" + ], + "default": [], + "description": "", + "properties": { + "_modified": { + "description": "The date and time the preferences were updated.", + "format": "date-time", + "readonly": false, + "type": "string" + } + }, + "type": "object" + }, + "woocommerce_coming_soon_banner_dismissed": { + "default": "", + "description": "Indicate whether the user has dismissed the coming soon notice or not.", + "type": "string" + }, + "woocommerce_launch_your_store_tour_hidden": { + "default": "", + "description": "Indicate whether the user has dismissed the site visibility tour on the home screen.", + "type": "string" + } + }, + "required": false, + "type": "object" + }, + "name": { + "description": "Display name for the user.", + "required": false, + "type": "string" + }, + "nickname": { + "description": "The nickname for the user.", + "required": false, + "type": "string" + }, + "password": { + "description": "Password for the user (never included).", + "required": false, + "type": "string" + }, + "roles": { + "description": "Roles assigned to the user.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" + }, + "slug": { + "description": "An alphanumeric identifier for the user.", + "required": false, + "type": "string" + }, + "url": { + "description": "URL of the user.", + "format": "uri", + "required": false, + "type": "string" + }, + "username": { + "description": "Login name for the user.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "args": { + "force": { + "default": false, + "description": "Required to be true, as users do not support binning.", + "required": false, + "type": "boolean" + }, + "reassign": { + "description": "Reassign the deleted user's posts and links to this user ID.", + "required": true, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] + } + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/widget-types": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/widget-types" } ] - } - }, - "/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)": { - "namespace": "wp/v2", + }, + "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" + } + }, + "methods": [ + "GET" + ] + } + ], "methods": [ "GET" ], + "namespace": "wp/v2" + }, + "/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": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "id": { + "description": "The widget type ID.", + "required": false, + "type": "string" + } + }, "methods": [ "GET" - ], - "args": { - "id": { - "description": "The widget type ID.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } + ] } - ] - }, - "/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)/encode": { - "namespace": "wp/v2", - "methods": [ - "POST" ], + "methods": [ + "GET" + ], + "namespace": "wp/v2" + }, + "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)/encode": { "endpoints": [ { - "methods": [ - "POST" - ], "args": { - "id": { - "description": "The widget type ID.", - "type": "string", - "required": true - }, - "instance": { - "description": "Current instance settings of the widget.", - "type": "object", - "required": false - }, "form_data": { "description": "Serialised widget form data to encode into instance settings.", - "type": "string", - "required": false - } - } - } - ] - }, - "/wp/v2/widget-types/(?P\u003Cid\u003E[a-zA-Z0-9_-]+)/render": { - "namespace": "wp/v2", - "methods": [ - "POST" - ], - "endpoints": [ - { - "methods": [ - "POST" - ], - "args": { + "required": false, + "type": "string" + }, "id": { "description": "The widget type ID.", - "type": "string", - "required": true + "required": true, + "type": "string" }, "instance": { "description": "Current instance settings of the widget.", - "type": "object", - "required": false + "required": false, + "type": "object" } - } - } - ] - }, - "/wp/v2/widgets": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "allow_batch": { - "v1": true }, - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - }, - "sidebar": { - "description": "The sidebar for which to return widgets.", - "type": "string", - "required": false - } - } - }, - { "methods": [ "POST" - ], - "allow_batch": { - "v1": true - }, - "args": { - "id": { - "description": "Unique identifier for the widget.", - "type": "string", - "required": false - }, - "id_base": { - "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", - "type": "string", - "required": false - }, - "sidebar": { - "default": "wp_inactive_widgets", - "description": "The sidebar to which the widget belongs.", - "type": "string", - "required": true - }, - "instance": { - "description": "Instance settings of the widget, if supported.", - "type": "object", - "properties": { - "encoded": { - "description": "Base64 encoded representation of the instance settings.", - "type": "string", - "context": [ - "edit" - ] - }, - "hash": { - "description": "Cryptographic hash of the instance settings.", - "type": "string", - "context": [ - "edit" - ] - }, - "raw": { - "description": "Unencoded instance settings, if supported.", - "type": "object", - "context": [ - "edit" - ] - } - }, - "required": false - }, - "form_data": { - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", - "type": "string", - "required": false - } - } + ] } ], + "methods": [ + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/widget-types/(?P[a-zA-Z0-9_-]+)/render": { + "endpoints": [ + { + "args": { + "id": { + "description": "The widget type ID.", + "required": true, + "type": "string" + }, + "instance": { + "description": "Current instance settings of the widget.", + "required": false, + "type": "object" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/widgets": { "_links": { "self": [ { "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/widgets" } ] - } - }, - "/wp/v2/widgets/(?P\u003Cid\u003E[\\w\\-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE" - ], + }, "endpoints": [ { - "methods": [ - "GET" - ], "allow_batch": { "v1": true }, "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" + }, + "sidebar": { + "description": "The sidebar for which to return widgets.", + "required": false, + "type": "string" } - } + }, + "methods": [ + "GET" + ] }, { - "methods": [ - "POST", - "PUT", - "PATCH" - ], "allow_batch": { "v1": true }, "args": { + "form_data": { + "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", + "required": false, + "type": "string" + }, "id": { "description": "Unique identifier for the widget.", - "type": "string", - "required": false + "required": false, + "type": "string" }, "id_base": { "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", - "type": "string", - "required": false - }, - "sidebar": { - "description": "The sidebar to which the widget belongs.", - "type": "string", - "required": false + "required": false, + "type": "string" }, "instance": { "description": "Instance settings of the widget, if supported.", - "type": "object", "properties": { "encoded": { - "description": "Base64 encoded representation of the instance settings.", - "type": "string", "context": [ "edit" - ] + ], + "description": "Base64 encoded representation of the instance settings.", + "type": "string" }, "hash": { - "description": "Cryptographic hash of the instance settings.", - "type": "string", "context": [ "edit" - ] + ], + "description": "Cryptographic hash of the instance settings.", + "type": "string" }, "raw": { - "description": "Unencoded instance settings, if supported.", - "type": "object", "context": [ "edit" - ] + ], + "description": "Unencoded instance settings, if supported.", + "type": "object" } }, - "required": false + "required": false, + "type": "object" }, - "form_data": { - "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", - "type": "string", - "required": false + "sidebar": { + "default": "wp_inactive_widgets", + "description": "The sidebar to which the widget belongs.", + "required": true, + "type": "string" } - } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/widgets/(?P[\\w\\-]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, + "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" + } + }, + "methods": [ + "GET" + ] }, { + "allow_batch": { + "v1": true + }, + "args": { + "form_data": { + "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the widget.", + "required": false, + "type": "string" + }, + "id_base": { + "description": "The type of the widget. Corresponds to ID in widget-types endpoint.", + "required": false, + "type": "string" + }, + "instance": { + "description": "Instance settings of the widget, if supported.", + "properties": { + "encoded": { + "context": [ + "edit" + ], + "description": "Base64 encoded representation of the instance settings.", + "type": "string" + }, + "hash": { + "context": [ + "edit" + ], + "description": "Cryptographic hash of the instance settings.", + "type": "string" + }, + "raw": { + "context": [ + "edit" + ], + "description": "Unencoded instance settings, if supported.", + "type": "object" + } + }, + "required": false, + "type": "object" + }, + "sidebar": { + "description": "The sidebar to which the widget belongs.", + "required": false, + "type": "string" + } + }, "methods": [ - "DELETE" - ], + "PATCH", + "POST", + "PUT" + ] + }, + { "allow_batch": { "v1": true }, "args": { "force": { "description": "Whether to force removal of the widget, or move it to the inactive sidebar.", - "type": "boolean", - "required": false + "required": false, + "type": "boolean" } - } - } - ] - }, - "/wp/v2/block-directory/search": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { + }, "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view" - ], - "default": "view", - "required": false - }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false - }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100, - "required": false - }, - "term": { - "description": "Limit result set to blocks matching the search term.", - "type": "string", - "minLength": 1, - "required": true - } - } + "DELETE" + ] } ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" + }, + "/wp/v2/wp_pattern_category": { "_links": { "self": [ { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-directory/search" + "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/wp_pattern_category" } ] - } - }, - "/wp/v2/pattern-directory/patterns": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], + }, "endpoints": [ { - "methods": [ - "GET" - ], + "allow_batch": { + "v1": true + }, "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "description": "Scope under which the request is made; determines fields present in response.", + "enum": [ + "edit", + "embed", + "view" + ], + "required": false, + "type": "string" }, - "page": { - "description": "Current page of the collection.", - "type": "integer", - "default": 1, - "minimum": 1, - "required": false + "exclude": { + "default": [], + "description": "Ensure result set excludes specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" }, - "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", - "default": 100, - "minimum": 1, - "maximum": 100, - "required": false + "hide_empty": { + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "required": false, + "type": "boolean" }, - "search": { - "description": "Limit results to those matching a string.", - "type": "string", - "minLength": 1, - "required": false - }, - "category": { - "description": "Limit results to those matching a category ID.", - "type": "integer", - "minimum": 1, - "required": false - }, - "keyword": { - "description": "Limit results to those matching a keyword ID.", - "type": "integer", - "minimum": 1, - "required": false - }, - "slug": { - "description": "Limit results to those matching a pattern (slug).", - "type": "array", - "required": false + "include": { + "default": [], + "description": "Limit result set to specific IDs.", + "items": { + "type": "integer" + }, + "required": false, + "type": "array" }, "offset": { "description": "Offset the result set by a specific number of items.", - "type": "integer", - "required": false + "required": false, + "type": "integer" }, "order": { + "default": "asc", "description": "Order sort attribute ascending or descending.", - "type": "string", - "default": "desc", "enum": [ "asc", "desc" ], - "required": false + "required": false, + "type": "string" }, "orderby": { - "description": "Sort collection by post attribute.", - "type": "string", - "default": "date", + "default": "name", + "description": "Sort collection by term attribute.", "enum": [ - "author", - "date", + "count", + "description", "id", "include", - "modified", - "parent", - "relevance", - "slug", "include_slugs", - "title", - "favorite_count" + "name", + "slug", + "term_group" ], - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/pattern-directory/patterns" - } - ] - } - }, - "/wp/v2/block-patterns/patterns": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/patterns" - } - ] - } - }, - "/wp/v2/block-patterns/categories": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/block-patterns/categories" - } - ] - } - }, - "/wp-site-health/v1": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wp-site-health/v1", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1" - } - ] - } - }, - "/wp-site-health/v1/tests/background-updates": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/background-updates" - } - ] - } - }, - "/wp-site-health/v1/tests/loopback-requests": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/loopback-requests" - } - ] - } - }, - "/wp-site-health/v1/tests/https-status": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/https-status" - } - ] - } - }, - "/wp-site-health/v1/tests/dotorg-communication": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/dotorg-communication" - } - ] - } - }, - "/wp-site-health/v1/tests/authorization-header": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/authorization-header" - } - ] - } - }, - "/wp-site-health/v1/directory-sizes": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/directory-sizes" - } - ] - } - }, - "/wp-site-health/v1/tests/page-cache": { - "namespace": "wp-site-health/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-site-health/v1/tests/page-cache" - } - ] - } - }, - "/wp-block-editor/v1": { - "namespace": "wp-block-editor/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "namespace": { - "default": "wp-block-editor/v1", - "required": false - }, - "context": { - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1" - } - ] - } - }, - "/wp-block-editor/v1/url-details": { - "namespace": "wp-block-editor/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "url": { - "description": "The URL to process.", - "type": "string", - "format": "uri", - "required": true - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/url-details" - } - ] - } - }, - "/wp/v2/menu-locations": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/menu-locations" - } - ] - } - }, - "/wp/v2/menu-locations/(?P\u003Clocation\u003E[\\w-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "location": { - "description": "An alphanumeric identifier for the menu location.", - "type": "string", - "required": false - }, - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false - } - } - } - ] - }, - "/wp-block-editor/v1/export": { - "namespace": "wp-block-editor/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/export" - } - ] - } - }, - "/wp-block-editor/v1/navigation-fallback": { - "namespace": "wp-block-editor/v1", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": [] - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp-block-editor/v1/navigation-fallback" - } - ] - } - }, - "/wp/v2/font-collections": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { - "methods": [ - "GET" - ], - "args": { - "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], - "default": "view", - "required": false + "required": false, + "type": "string" }, "page": { - "description": "Current page of the collection.", - "type": "integer", "default": 1, + "description": "Current page of the collection.", "minimum": 1, - "required": false + "required": false, + "type": "integer" }, "per_page": { - "description": "Maximum number of items to be returned in result set.", - "type": "integer", "default": 10, - "minimum": 1, + "description": "Maximum number of items to be returned in result set.", "maximum": 100, - "required": false + "minimum": 1, + "required": false, + "type": "integer" + }, + "post": { + "default": null, + "description": "Limit result set to terms assigned to a specific post.", + "required": false, + "type": "integer" + }, + "search": { + "description": "Limit results to those matching a string.", + "required": false, + "type": "string" + }, + "slug": { + "description": "Limit result set to terms with one or more specific slugs.", + "items": { + "type": "string" + }, + "required": false, + "type": "array" } - } - } - ], - "_links": { - "self": [ - { - "href": "https://haikuatelier.fr.ddev.site/wp-json/wp/v2/font-collections" - } - ] - } - }, - "/wp/v2/font-collections/(?P\u003Cslug\u003E[\\/\\w-]+)": { - "namespace": "wp/v2", - "methods": [ - "GET" - ], - "endpoints": [ - { + }, "methods": [ "GET" - ], + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "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.", + "required": false, + "type": "string" + } + }, + "methods": [ + "POST" + ] + } + ], + "methods": [ + "GET", + "POST" + ], + "namespace": "wp/v2" + }, + "/wp/v2/wp_pattern_category/(?P[\\d]+)": { + "endpoints": [ + { + "allow_batch": { + "v1": true + }, "args": { "context": { - "description": "Scope under which the request is made; determines fields present in response.", - "type": "string", - "enum": [ - "view", - "embed", - "edit" - ], "default": "view", - "required": false + "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 term.", + "required": false, + "type": "integer" } - } + }, + "methods": [ + "GET" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "description": { + "description": "HTML description of the term.", + "required": false, + "type": "string" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + }, + "meta": { + "description": "Meta fields.", + "properties": [], + "required": false, + "type": "object" + }, + "name": { + "description": "HTML title for the term.", + "required": false, + "type": "string" + }, + "slug": { + "description": "An alphanumeric identifier for the term unique to its type.", + "required": false, + "type": "string" + } + }, + "methods": [ + "PATCH", + "POST", + "PUT" + ] + }, + { + "allow_batch": { + "v1": true + }, + "args": { + "force": { + "default": false, + "description": "Required to be true, as terms do not support binning.", + "required": false, + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the term.", + "required": false, + "type": "integer" + } + }, + "methods": [ + "DELETE" + ] } - ] + ], + "methods": [ + "DELETE", + "GET", + "PATCH", + "POST", + "PUT" + ], + "namespace": "wp/v2" } }, - "site_logo": 0, "site_icon": 0, "site_icon_url": "", - "_links": { - "help": [ - { - "href": "https://developer.wordpress.org/rest-api/" - } - ] - } + "site_logo": 0, + "timezone_string": "Europe/Brussels", + "url": "https://haikuatelier.fr.ddev.site/wp" } diff --git a/mago-schema.json b/mago-schema.json new file mode 100644 index 00000000..1cb5d367 --- /dev/null +++ b/mago-schema.json @@ -0,0 +1,8329 @@ +{ + "$defs": { + "AnalyzerConfiguration": { + "additionalProperties": false, + "description": "Configuration options for the static analyzer.", + "properties": { + "allow-implicit-pipe-callable-types": { + "default": false, + "description": "Skip missing-type-hint checks for closures and arrow functions used\nas the right-hand side of the pipe operator (`|>`).\n\nWhen `true`, an inline pipe callable like\n`$x |> fn($p) => strtoupper($p)` will not warn about missing parameter\nor return types, even when the closure / arrow-function checks are\notherwise enabled. The pipe operand's type is enough to derive the\nparameter type, so the hint is mostly noise.\n\nDefaults to `false`.", + "type": "boolean" + }, + "allow-possibly-undefined-array-keys": { + "default": true, + "description": "Allow accessing array keys that may not be defined without reporting an issue.", + "type": "boolean" + }, + "allow-side-effects-in-conditions": { + "default": true, + "description": "Whether to allow calls to impure functions inside conditions.\n\nWhen set to `false`, any call to a function not marked `@pure` or\n`@mutation-free` inside an `if`, `while`, `for`, ternary, or `match`\ncondition is reported. This helps catch surprising evaluation-order\nbugs where a side effect in one part of a condition silently alters\na variable used in another part.\n\nDefaults to `true` (impure calls in conditions are allowed).", + "type": "boolean" + }, + "analyze-dead-code": { + "default": false, + "description": "Whether to analyze dead code.", + "type": "boolean" + }, + "baseline": { + "default": null, + "description": "Path to a baseline file to ignore listed issues.", + "type": [ + "null", + "string" + ] + }, + "baseline-variant": { + "$ref": "#/$defs/BaselineVariant", + "default": "loose", + "description": "The baseline variant to use when generating new baselines.\n\nOptions:\n\n- `\"strict\"`: Exact line matching with start/end line numbers\n- `\"loose\"`: Count-based matching by (file, code, message) tuple (default)\n\nThe loose variant is more resilient to code changes as line number shifts\ndon't affect the baseline." + }, + "check-arrow-function-missing-type-hints": { + "default": false, + "description": "Check for missing type hints (both parameters and return types) in arrow functions when `check_missing_type_hints` is enabled.\n\nWhen `true`, arrow functions (declared with `fn() => ...`) will be checked for missing\ntype hints. When `false`, arrow functions are ignored, which is useful because arrow\nfunctions often rely on type inference and are typically short, making types obvious.\n\nDefaults to `false`.", + "type": "boolean" + }, + "check-closure-missing-type-hints": { + "default": false, + "description": "Check for missing type hints (both parameters and return types) in closures when `check_missing_type_hints` is enabled.\n\nWhen `true`, closures (anonymous functions declared with `function() {}`) will be\nchecked for missing type hints. When `false`, closures are ignored, which is useful\nbecause closures often rely on type inference.\n\nDefaults to `false`.", + "type": "boolean" + }, + "check-experimental": { + "default": false, + "description": "Check for incorrect casing when referencing classes, interfaces, traits, enums,\nand functions.\n\nDefaults to `false`.", + "type": "boolean" + }, + "check-missing-override": { + "default": false, + "description": "Check for missing `#[Override]` attributes on overriding methods.\n\nWhen enabled, the analyzer reports methods that override a parent method without\nthe `#[Override]` attribute (PHP 8.3+).\n\nDefaults to `true`.", + "type": "boolean" + }, + "check-missing-type-hints": { + "default": false, + "description": "Check for missing type hints on parameters, properties, and return types.\n\nWhen enabled, the analyzer will report warnings for function parameters, class properties,\nand function return types that lack explicit type declarations.\n\nDefaults to `false`.", + "type": "boolean" + }, + "check-name-casing": { + "default": false, + "description": "Defaults to `false`.", + "type": "boolean" + }, + "check-property-initialization": { + "default": false, + "description": "Enable property initialization checking (`missing-constructor`, `uninitialized-property`).\n\nWhen `false`, disables both `missing-constructor` and `uninitialized-property` issues\nentirely. This is useful for projects that prefer to rely on runtime errors for\nproperty initialization.\n\nDefaults to `false`.", + "type": "boolean" + }, + "check-throws": { + "default": false, + "description": "Whether to check for thrown exceptions.", + "type": "boolean" + }, + "check-use-statements": { + "default": false, + "description": "Check for non-existent symbols in use statements.\n\nWhen enabled, the analyzer will report use statements that import symbols\n(classes, interfaces, traits, enums, functions, or constants) that do not exist\nin the codebase.\n\nDefaults to `false`.", + "type": "boolean" + }, + "class-initializers": { + "default": [], + "description": "Method names treated as class initializers (like `__construct`).\n\nProperties initialized in these methods count as \"definitely initialized\"\njust like in the constructor. This is useful for frameworks that use\nlifecycle methods like PHPUnit's `setUp()` or framework `boot()` methods.\n\nExample: `[\"setUp\", \"initialize\", \"boot\"]`\n\nDefaults to empty (no additional initializers).", + "items": { + "type": "string" + }, + "type": "array" + }, + "disable-default-plugins": { + "default": false, + "description": "Disable all default plugins (including stdlib).\n\nWhen set to `true`, no plugins will be loaded by default, and only plugins\nexplicitly listed in `plugins` will be enabled.\n\nDefaults to `false`.", + "type": "boolean" + }, + "enforce-class-finality": { + "default": false, + "description": "Enforce that concrete classes are declared `final`.\n\nWhen enabled, the analyzer reports a warning for any class that is not\n`final`, `abstract`, or annotated with `@api`, provided the class has no children.\n\nDefaults to `false`.", + "type": "boolean" + }, + "excludes": { + "default": [], + "description": "A list of patterns to exclude from analysis.", + "items": { + "type": "string" + }, + "type": "array" + }, + "find-overly-wide-return-types": { + "default": false, + "description": "Whether to warn when a function's declared return type contains a branch the body never\nactually returns (e.g. `: string|false` on a function that always returns a string).", + "type": "boolean" + }, + "find-unused-definitions": { + "default": true, + "description": "Whether to find unused definitions.", + "type": "boolean" + }, + "find-unused-expressions": { + "default": true, + "description": "Whether to find unused expressions.", + "type": "boolean" + }, + "find-unused-parameters": { + "default": false, + "description": "Find and report unused function/method parameters.\n\nWhen enabled, the analyzer reports parameters that are declared but never used\nwithin the function body.\n\nDefaults to `true`.", + "type": "boolean" + }, + "ignore": { + "default": [], + "description": "Ignore specific issues based on their code, optionally scoped to paths.", + "items": { + "$ref": "#/$defs/IgnoreEntry" + }, + "type": "array" + }, + "memoize-properties": { + "default": true, + "description": "Whether to memoize properties.", + "type": "boolean" + }, + "minimum-fail-level": { + "$ref": "#/$defs/Level", + "default": "Error", + "description": "Set the minimum issue severity that causes the command to fail.\n\nThe command will exit with a non-zero status if any issues at or above\nthis level are found. For example, setting this to `\"warning\"` means\nthe command fails on warnings and errors, but not on notes or help suggestions.\n\nOptions: `\"note\"`, `\"help\"`, `\"warning\"`, `\"error\"`\n\nCan be overridden by the `--minimum-fail-level` CLI flag.\n\nDefaults to `\"error\"`." + }, + "no-boolean-literal-comparison": { + "default": false, + "description": "Disallow comparisons where a boolean literal is used as an operand.\n\nDefaults to `false`.", + "type": "boolean" + }, + "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" + ], + "writeOnly": true + }, + "performance": { + "$ref": "#/$defs/PerformanceConfiguration", + "default": { + "array-combination-threshold": 32, + "consensus-limit-threshold": 256, + "disjunction-complexity-threshold": 4096, + "formula-size-threshold": 512, + "integer-combination-threshold": 128, + "loop-assignment-depth-threshold": 1, + "negation-complexity-threshold": 4096, + "saturation-complexity-threshold": 8192, + "string-combination-threshold": 128 + }, + "description": "Performance tuning settings.\n\nThese thresholds control how deeply the analyzer explores complex logical formulas.\nHigher values allow more precise analysis but may significantly increase analysis time.\nLower values improve speed but may reduce precision on complex conditional code." + }, + "plugins": { + "default": [], + "description": "List of plugins to enable (by name or alias).\n\nPlugins can be specified by their canonical name or any of their aliases:\n- `stdlib` (aliases: `standard`, `std`, `php-stdlib`)\n- `psl` (aliases: `php-standard-library`, `azjezz-psl`)\n- `flow-php` (aliases: `flow`, `flow-etl`)\n- `psr-container` (aliases: `psr-11`)\n\nExample: `plugins = [\"stdlib\", \"psl\"]`", + "items": { + "type": "string" + }, + "type": "array" + }, + "register-super-globals": { + "default": true, + "description": "Register superglobals (e.g., `$_GET`, `$_POST`, `$_SERVER`) in the analysis context.\n\nIf disabled, super globals won't be available unless explicitly imported using\nthe `global` keyword.\n\nDefaults to `true`.", + "type": "boolean" + }, + "require-api-or-internal": { + "default": false, + "description": "Require `@api` or `@internal` annotations on abstract classes, interfaces, and traits.\n\nWhen enabled, the analyzer reports a warning for any abstract class, interface,\nor trait that is not annotated with either `@api` or `@internal`.\n\nDefaults to `false`.", + "type": "boolean" + }, + "strict-list-index-checks": { + "default": false, + "description": "Enforce strict checks when accessing list elements by index.\n\nWhen `true`, the analyzer requires that any integer used to access a `list`\nelement is provably non-negative (e.g., of type `int<0, max>`). This helps\nprevent potential runtime errors from using a negative index.\n\nWhen `false` (the default), any `int` is permitted as an index, offering\nmore flexibility at the cost of type safety.", + "type": "boolean" + }, + "trust-existence-checks": { + "default": true, + "description": "Trust symbol existence checks to narrow types.\n\nWhen enabled, conditional checks like `method_exists()`, `property_exists()`,\n`function_exists()`, and `defined()` will narrow the type within the conditional block,\nsuppressing errors for symbols that are verified to exist at runtime.\n\nWhen disabled, these checks are ignored and the analyzer requires explicit type hints,\nwhich is stricter but may produce more false positives for dynamic code.\n\nDefaults to `true`.", + "type": "boolean" + }, + "unchecked-exception-classes": { + "default": [], + "description": "Exceptions to ignore (exact class match only, not subclasses).\n\nWhen an exception class is listed here, only that exact class will be ignored\nduring `check_throws` analysis. Parent classes and subclasses are not affected.", + "items": { + "type": "string" + }, + "type": "array" + }, + "unchecked-exceptions": { + "default": [], + "description": "Exceptions to ignore including all subclasses (hierarchy-aware).\n\nWhen an exception class is listed here, any exception of that class or any of its\nsubclasses will be ignored during `check_throws` analysis.\n\nFor example, adding `LogicException` will ignore `LogicException`, `InvalidArgumentException`,\n`OutOfBoundsException`, and all other subclasses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ArrayStyleOption": { + "enum": [ + "long", + "short" + ], + "type": "string" + }, + "AssertionStyle": { + "enum": [ + "self_", + "static", + "this" + ], + "type": "string" + }, + "BaselineVariant": { + "description": "The variant of baseline format to use.", + "oneOf": [ + { + "const": "strict", + "description": "Strict baseline with exact line matching.\n\nEach issue is stored with its exact start and end line numbers.\nAny change in line numbers requires baseline regeneration.", + "type": "string" + }, + { + "const": "loose", + "description": "Loose baseline with count-based matching.\n\nIssues are grouped by (file, code, message) and stored with a count.\nMore resilient to code changes as line shifts don't affect the baseline.", + "type": "string" + } + ] + }, + "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": [ + "always_next_line", + "next_line", + "same_line" + ], + "type": "string" + }, + "DisallowedEntry": { + "anyOf": [ + { + "description": "Simple string entry (just the name).", + "type": "string" + }, + { + "description": "Entry with name and optional help message.", + "properties": { + "help": { + "type": [ + "null", + "string" + ] + }, + "name": { + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + ], + "description": "An entry that can be either a simple string or an object with name and optional help." + }, + "DisallowedTypeEntry": { + "anyOf": [ + { + "description": "Simple string entry (just the name).", + "type": "string" + }, + { + "description": "Entry with name and optional help message.", + "properties": { + "help": { + "type": [ + "null", + "string" + ] + }, + "name": { + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + ], + "description": "An entry that can be either a simple string or an object with name and optional help." + }, + "EndOfLine": { + "description": "Specifies the style of line endings.", + "enum": [ + "auto", + "cr", + "crlf", + "lf" + ], + "type": "string" + }, + "FormatterConfiguration": { + "additionalProperties": false, + "description": "Configuration options for formatting source code.", + "properties": { + "align-assignment-like": { + "default": false, + "description": "Whether to align consecutive assignment-like constructs in columns.\n\nWhen enabled, consecutive variable assignments, class properties, class constants,\nglobal constants, array key-value pairs, and backed enum cases are column-aligned.\n\nFor arrays, this applies to multiline or width-broken mappings. Compact inline arrays\nstay compact and are not padded into columns.\n\nExample with `true`:\n```php\n$foo = 1;\n$b = 2;\n$ccccccc = 3;\n\nclass X {\n public string $foo = 1;\n public readonly int $barrrr = 2;\n}\n```\n\nExample with `false`:\n```php\n$foo = 1;\n$b = 2;\n$ccccccc = 3;\n```\n\nNote: Blank lines and comments break alignment runs. In class bodies,\ndifferent member types (properties vs constants) are aligned separately.\n\nDefault: false", + "type": "boolean" + }, + "align-named-arguments": { + "default": false, + "description": "Whether to align named arguments in multiline argument lists.\n\nWhen enabled:\n```php\nsome_function(\n short: 1,\n longerName: 2,\n longestName: 3,\n);\n```\n\nSingle-line argument lists remain inline, and positional arguments are not aligned.\n\nDefault: false", + "type": "boolean" + }, + "align-parameters": { + "default": false, + "description": "Whether to align multiline function and method parameter lists by the variable column.\n\nThis is especially useful for promoted constructor properties with visibility modifiers.\n\nDefault: false", + "type": "boolean" + }, + "always-break-attribute-named-argument-lists": { + "default": false, + "description": "Whether to always break named argument lists in attributes into multiple lines.\n\nWhen enabled:\n```php\n#[SomeAttribute(\n argument1: 'value1',\n argument2: 'value2',\n)]\nclass Foo {}\n```\n\nDefault: false", + "type": "boolean" + }, + "always-break-named-arguments-list": { + "default": false, + "description": "Whether to always break named argument lists into multiple lines.\n\nWhen enabled:\n```php\n$foo = some_function(\n argument1: 'value1',\n argument2: 'value2',\n);\n```\n\nDefault: false", + "type": "boolean" + }, + "array-table-style-alignment": { + "default": true, + "description": "Whether to use table-style alignment for arrays.\n\nWhen enabled, array elements are aligned in a table-like format:\n```php\n$array = [\n ['foo', 1.2, 123, false],\n ['bar', 52.4, 456, true],\n ['baz', 3.6, 789, false],\n ['qux', 4.8, 1, true],\n ['quux', 5.0, 12, false],\n];\n```\n\nDefault: true", + "type": "boolean" + }, + "break-promoted-properties-list": { + "default": true, + "description": "Whether to break a parameter list with one or more promoted properties into multiple lines.\n\nWhen enabled, parameter lists with promoted properties are always multi-line:\n```php\nclass User {\n public function __construct(\n public string $name,\n public string $email,\n ) {}\n}\n```\n\nWhen disabled, they may be kept on a single line if space allows:\n```php\nclass User {\n public function __construct(public string $name, public string $email) {}\n}\n```\n\nDefault: true", + "type": "boolean" + }, + "classlike-brace-style": { + "$ref": "#/$defs/BraceStyle", + "default": "always_next_line", + "description": "Brace placement for class-like structures (classes, interfaces, traits, enums).\n\nExample with `same_line`:\n```php\nclass Foo {\n}\n```\n\nExample with `next_line` or `always_next_line`:\n```php\nclass Foo\n{\n}\n```\n\nDefault: `always_next_line`" + }, + "closure-brace-style": { + "$ref": "#/$defs/BraceStyle", + "default": "same_line", + "description": "Brace placement for closures.\n\nExample with `same_line`:\n```php\n$closure = function() {\n return 'Hello, world!';\n};\n```\n\nExample with `next_line`:\n```php\n$closure = function()\n{\n return 'Hello, world!';\n};\n```\n\nDefault: `same_line`" + }, + "control-brace-style": { + "$ref": "#/$defs/BraceStyle", + "default": "same_line", + "description": "Brace placement for control structures (if, for, while, etc.).\n\nExample with `same_line`:\n```php\nif ($expr) {\n return 'Hello, world!';\n}\n```\n\nExample with `next_line`:\n```php\nif ($expr)\n{\n return 'Hello, world!';\n}\n```\n\nDefault: `same_line`" + }, + "empty-line-after-class-like-constant": { + "default": false, + "description": "Whether to add an empty line after class-like constant.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-after-class-like-open": { + "default": false, + "description": "Whether to add an empty line immediately after a class-like opening brace.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-after-control-structure": { + "default": false, + "description": "Whether to add an empty line after control structures (if, for, foreach, while, do, switch).\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-after-declare": { + "default": true, + "description": "Whether to add an empty line after declare statement.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: true", + "type": "boolean" + }, + "empty-line-after-enum-case": { + "default": false, + "description": "Whether to add an empty line after enum case.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-after-method": { + "default": true, + "description": "Whether to add an empty line after method.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: true", + "type": "boolean" + }, + "empty-line-after-namespace": { + "default": true, + "description": "Whether to add an empty line after namespace.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: true", + "type": "boolean" + }, + "empty-line-after-opening-tag": { + "default": true, + "description": "Whether to add an empty line after opening tag.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: true", + "type": "boolean" + }, + "empty-line-after-property": { + "default": false, + "description": "Whether to add an empty line after property.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-after-symbols": { + "default": true, + "description": "Whether to add an empty line after symbols (class, enum, interface, trait, function, const).\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: true", + "type": "boolean" + }, + "empty-line-after-trait-use": { + "default": false, + "description": "Whether to add an empty line after trait use.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-after-use": { + "default": true, + "description": "Whether to add an empty line after use statements.\n\nNote: if an empty line already exists, it will be preserved regardless of this\nsettings value.\n\nDefault: true", + "type": "boolean" + }, + "empty-line-before-class-like-close": { + "default": false, + "description": "Whether to insert an empty line before the closing brace of class-like\nstructures when the class body is not empty.\n\nWhen enabled, a blank line will be inserted immediately before the `}`\nthat closes a class, trait, interface or enum, but only if the body\ncontains at least one member.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-before-dangling-comments": { + "default": true, + "description": "Whether to add an empty line before dangling comments.\n\nDefault: true", + "type": "boolean" + }, + "empty-line-before-return": { + "default": false, + "description": "Whether to add an empty line before return statements.\n\nDefault: false", + "type": "boolean" + }, + "empty-line-between-same-symbols": { + "default": true, + "description": "Whether to add an empty line between consecutive symbols of the same type.\n\nOnly applies when `empty_line_after_symbols` is true.\n\nDefault: true", + "type": "boolean" + }, + "end-of-line": { + "$ref": "#/$defs/EndOfLine", + "default": "auto", + "description": "End-of-line characters to use.\n\nDefault: \"lf\"" + }, + "excludes": { + "description": "A list of patterns to exclude from formatting.\n\nDefaults to `[]`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "expand-use-groups": { + "default": true, + "description": "Whether to expand grouped use statements into individual statements.\n\nWhen enabled:\n```php\nuse Foo\\Bar;\nuse Foo\\Baz;\n```\n\nWhen disabled:\n```php\nuse Foo\\{Bar, Baz};\n```\n\nDefault: true", + "type": "boolean" + }, + "first-method-chain-on-new-line": { + "default": true, + "description": "When method chaining breaks across lines, place the first method on a new line.\n\nThis follows PER-CS 4.7: \"When [method chaining is] put on separate lines, [...] the first method MUST be on the next line.\"\n\nWhen enabled:\n```php\n$this\n ->getCache()\n ->forget();\n```\n\nWhen disabled:\n```php\n$this->getCache()\n ->forget();\n```\n\nDefault: `true`", + "type": "boolean" + }, + "following-clause-on-newline": { + "default": false, + "description": "Whether to place `else`, `elseif`, `catch` and `finally` on a new line.\n\nDefault: false", + "type": "boolean" + }, + "function-brace-style": { + "$ref": "#/$defs/BraceStyle", + "default": "next_line", + "description": "Brace placement for function declarations.\n\nExample with `same_line`:\n```php\nfunction foo() {\n return 'Hello, world!';\n}\n```\n\nExample with `next_line`:\n```php\nfunction foo()\n{\n return 'Hello, world!';\n}\n```\n\nDefault: `next_line`" + }, + "indent-binary-expression-continuation": { + "default": false, + "description": "Whether to indent continuation lines of binary expressions.\n\nWhen enabled, if a binary expression breaks across lines, the continuation\nis indented relative to the start of the expression:\n```php\n$emailNotifications = $this->stringUtils->splitStringToArray($jobPosting->getVacancyEmailNotification())\n ?? [];\n```\n\nWhen disabled, the continuation aligns with the start of the assignment:\n```php\n$emailNotifications = $this->stringUtils->splitStringToArray($jobPosting->getVacancyEmailNotification())\n?? [];\n```\n\nDefault: false", + "type": "boolean" + }, + "indent-heredoc": { + "default": true, + "description": "Whether to indent heredoc/nowdoc content.\n\nDefault: true", + "type": "boolean" + }, + "inline-abstract-property-hooks": { + "default": true, + "description": "Whether to keep abstract property hooks inline.\n\nWhen enabled: `public int $id { get; }`\nWhen disabled: hook list is always expanded\n\nDefault: true ([PER-CS 4.10](https://www.php-fig.org/per/coding-style/#410-interface-and-abstract-properties) compliant)", + "type": "boolean" + }, + "inline-empty-anonymous-class-braces": { + "default": true, + "description": "Place empty anonymous class bodies on the same line.\n\nExample with `false`:\n```php\n$anon = new class\n{\n};\n```\n\nExample with `true`:\n```php\n$anon = new class {};\n```\n\nDefault: true", + "type": "boolean" + }, + "inline-empty-classlike-braces": { + "default": true, + "description": "Place empty class-like bodies on the same line.\n\nExample with `false`:\n```php\nclass Foo\n{\n}\n```\n\nExample with `true`:\n```php\nclass Foo {}\n```\n\nDefault: true", + "type": "boolean" + }, + "inline-empty-closure-braces": { + "default": true, + "description": "Place empty closure bodies on the same line.\n\nExample with `false`:\n```php\n$closure = function()\n{\n};\n```\n\nExample with `true`:\n```php\n$closure = function() {};\n```\n\nDefault: true", + "type": "boolean" + }, + "inline-empty-constructor-braces": { + "default": true, + "description": "Place empty constructor bodies on the same line.\n\nExample with `false`:\n```php\nclass Foo {\n public function __construct()\n {\n }\n}\n```\n\nExample with `true`:\n```php\nclass Foo {\n public function __construct() {}\n}\n```\n\nDefault: true", + "type": "boolean" + }, + "inline-empty-control-braces": { + "default": false, + "description": "Place empty control structure bodies on the same line.\n\nExample with `false`:\n```php\nif ($expr)\n{\n}\n```\n\nExample with `true`:\n```php\nif ($expr) {}\n```\n\nDefault: false", + "type": "boolean" + }, + "inline-empty-function-braces": { + "default": true, + "description": "Place empty function bodies on the same line.\n\nExample with `false`:\n```php\nfunction foo()\n{\n}\n```\n\nExample with `true`:\n```php\nfunction foo() {}\n```\n\nDefault: true", + "type": "boolean" + }, + "inline-empty-method-braces": { + "default": true, + "description": "Place empty method bodies on the same line.\n\nExample with `false`:\n```php\nclass Foo\n{\n public function bar()\n {\n }\n}\n```\n\nExample with `true`:\n```php\nclass Foo\n{\n public function bar() {}\n}\n```\n\nDefault: true", + "type": "boolean" + }, + "line-before-binary-operator": { + "default": true, + "description": "Whether to add a line before binary operators or after when breaking.\n\nWhen true:\n```php\n$foo = 'Hello, '\n . 'world!';\n```\n\nWhen false:\n```php\n$foo = 'Hello, ' .\n 'world!';\n```\n\nNote: If the right side has a leading comment, this setting is always false.\n\nDefault: true", + "type": "boolean" + }, + "method-brace-style": { + "$ref": "#/$defs/BraceStyle", + "default": "next_line", + "description": "Brace placement for method declarations.\n\nExample with `same_line`:\n```php\nclass Foo\n{\n public function bar() {\n return 'Hello, world!';\n }\n}\n```\n\nExample with `next_line`:\n```php\nclass Foo\n{\n public function bar()\n {\n return 'Hello, world!';\n }\n}\n```\n\nDefault: `next_line`" + }, + "method-chain-breaking-style": { + "$ref": "#/$defs/MethodChainBreakingStyle", + "default": "next_line", + "description": "How to format broken method/property chains.\n\nWhen `next_line`, the first method/property starts on a new line:\n```php\n$foo\n ->bar()\n ->baz();\n```\n\nWhen `same_line`, the first method/property stays on the same line:\n```php\n$foo->bar()\n ->baz();\n```\n\nDefault: `next_line`" + }, + "method-chain-semicolon-on-next-line": { + "default": false, + "description": "When a method chain breaks across multiple lines, place the semicolon on its own line.\n\nWhen enabled:\n```php\n$object->method1()\n ->method2()\n ->method3()\n;\n```\n\nWhen disabled:\n```php\n$object->method1()\n ->method2()\n ->method3();\n```\n\nDefault: `false`", + "type": "boolean" + }, + "null-type-hint": { + "$ref": "#/$defs/NullTypeHint", + "default": "question", + "description": "How to format null type hints.\n\nWith `Question`:\n```php\nfunction foo(\n ?string $a,\n null|int|string $b,\n int|null|string $c,\n) {}\n```\n\nWith `NullPipe`:\n```php\nfunction foo(\n null|string $a,\n null|int|string $b,\n int|null|string $c,\n) {}\n```\n\nWith `NullPipeLast`:\n```php\nfunction foo(\n string|null $a,\n int|string|null $b,\n int|string|null $c,\n) {}\n```\n\nDefault: `Question`" + }, + "omit-redundant-arithmetic-binary-expression-parentheses": { + "default": false, + "description": "Whether to omit redundant parentheses around arithmetic binary expressions under comparison and null coalesce expressions.\n\nWhen enabled, parentheses are omitted where PHP precedence already preserves meaning:\n```php\nif ($i === $retries - 1) {\n}\n```\n\nWhen disabled, arithmetic binary expressions keep Mago's default grouping style:\n```php\nif ($i === ($retries - 1)) {\n}\n```\n\nDefault: false", + "type": "boolean" + }, + "omit-redundant-bitwise-binary-expression-parentheses": { + "default": false, + "description": "Whether to omit redundant parentheses around bitwise binary child expressions.\n\nWhen enabled, parentheses are omitted around bitwise binary child expressions where PHP precedence and\nassociativity already preserve meaning:\n```php\nif ($mask === $flags << 1) {\n}\n```\n\nWhen disabled, bitwise binary child expressions keep Mago's default grouping style:\n```php\nif ($mask === ($flags << 1)) {\n}\n```\n\nDefault: false", + "type": "boolean" + }, + "opening-tag-on-own-line": { + "default": true, + "description": "Whether the opening `bar();\n```\n\nWhen disabled (PHP 8.4+ only):\n```php\n$foo = new Foo->bar();\n```\n\nDefault: false", + "type": "boolean" + }, + "parentheses-in-attribute": { + "default": false, + "description": "Whether to include parentheses in attributes with no arguments.\n\nWhen enabled:\n```php\n#[SomeAttribute()]\nclass Foo {}\n```\n\nWhen disabled:\n```php\n#[SomeAttribute]\nclass Foo {}\n```\n\nDefault: false", + "type": "boolean" + }, + "parentheses-in-exit-and-die": { + "default": true, + "description": "Whether to include parentheses in `exit` and `die` constructs.\n\nWhen enabled:\n```php\nexit();\ndie();\n```\n\nWhen disabled:\n```php\nexit;\ndie;\n```\n\nDefault: true", + "type": "boolean" + }, + "parentheses-in-new-expression": { + "default": true, + "description": "Whether to include parentheses in `new` expressions when no arguments are provided.\n\nWhen enabled:\n```php\n$foo = new Foo();\n```\n\nWhen disabled:\n```php\n$foo = new Foo;\n```\n\nDefault: true", + "type": "boolean" + }, + "preserve-breaking-argument-list": { + "default": false, + "description": "Whether to preserve line breaks in argument lists, even if they could fit on a single line.\n\nDefault: false", + "type": "boolean" + }, + "preserve-breaking-array-like": { + "default": true, + "description": "Whether to preserve line breaks in array-like structures, even if they could fit on a single line.\n\nDefault: true", + "type": "boolean" + }, + "preserve-breaking-attribute-list": { + "default": false, + "description": "Whether to preserve line breaks in attribute lists, even if they could fit on a single line.\n\nDefault: false", + "type": "boolean" + }, + "preserve-breaking-condition-expression": { + "default": false, + "description": "Whether to preserve line breaks in condition expressions (if, elseif, while, do-while, switch, match).\n\nWhen enabled, if the original source has conditions broken across multiple lines,\nthe formatter maintains that layout using PER Coding Style 3.0 rules.\n\nDefault: false", + "type": "boolean" + }, + "preserve-breaking-conditional-expression": { + "default": false, + "description": "Whether to preserve line breaks in conditional (ternary) expressions.\n\nDefault: false", + "type": "boolean" + }, + "preserve-breaking-member-access-chain": { + "default": false, + "description": "Whether to preserve line breaks in method chains, even if they could fit on a single line.\n\nDefault: false", + "type": "boolean" + }, + "preserve-breaking-member-access-chain-first-method-on-same-line": { + "default": false, + "description": "When preserving a broken object method chain, keep the first method call on the same line as the receiver.\n\nThis only affects already-broken object chains preserved by\n`preserve_breaking_member_access_chain`, and does not change the default\nbreaking style for newly broken chains.\n\nWhen enabled:\n```php\n$object->method1()\n ->method2()\n ->method3();\n```\n\nWhen disabled:\n```php\n$object\n ->method1()\n ->method2()\n ->method3();\n```\n\nDefault: false", + "type": "boolean" + }, + "preserve-breaking-parameter-list": { + "default": false, + "description": "Whether to preserve line breaks in parameter lists, even if they could fit on a single line.\n\nDefault: false", + "type": "boolean" + }, + "preserve-redundant-logical-binary-expression-parentheses": { + "default": false, + "description": "Whether to preserve author-written parentheses around logical binary sub-expressions\neven when PHP's operator precedence makes them redundant.\n\nWhen enabled, explicit grouping parentheses that an author added for clarity are kept:\n```php\nif (($var1 > 200 && $var2 < 1) || ($var1 <= 200 && $var2 < 3)) {\n}\n```\n\nWhen disabled (the default), the formatter removes parentheses that the precedence rules\nalready imply:\n```php\nif ($var1 > 200 && $var2 < 1 || $var1 <= 200 && $var2 < 3) {\n}\n```\n\nThis only applies to logical operators (`&&`, `||`, `and`, `or`, `xor`): parentheses\nthat group a logical sub-expression inside another logical expression.\n\nDefault: false", + "type": "boolean" + }, + "preset": { + "anyOf": [ + { + "$ref": "#/$defs/FormatterPreset" + }, + { + "type": "null" + } + ] + }, + "print-width": { + "default": 120, + "description": "Maximum line length that the printer will wrap on.\n\nDefault: 120", + "format": "uint", + "minimum": 0, + "type": "integer" + }, + "remove-trailing-close-tag": { + "default": true, + "description": "Whether to remove the trailing PHP close tag (`?>`) from files.\n\nDefault: true", + "type": "boolean" + }, + "separate-class-like-members": { + "default": true, + "description": "Whether to separate class-like members of different kinds with a blank line.\n\nDefault: true", + "type": "boolean" + }, + "separate-use-types": { + "default": true, + "description": "Whether to insert a blank line between different types of use statements.\n\nWhen enabled:\n```php\nuse Foo\\Bar;\nuse Foo\\Baz;\n\nuse function Foo\\bar;\nuse function Foo\\baz;\n\nuse const Foo\\A;\nuse const Foo\\B;\n```\n\nWhen disabled:\n```php\nuse Foo\\Bar;\nuse Foo\\Baz;\nuse function Foo\\bar;\nuse function Foo\\baz;\nuse const Foo\\A;\nuse const Foo\\B;\n```\n\nDefault: true", + "type": "boolean" + }, + "single-quote": { + "default": true, + "description": "Whether to use single quotes instead of double quotes for strings.\n\nThe formatter automatically determines which quotes to use based on the string content,\nwith a preference for single quotes if this option is enabled.\n\nDecision logic:\n- If the string contains more single quotes than double quotes, double quotes are used\n- If the string contains more double quotes than single quotes, single quotes are used\n- If equal number of both, single quotes are used if this option is true\n\nDefault: true", + "type": "boolean" + }, + "sort-class-methods": { + "default": false, + "description": "Whether to sort class methods by visibility and name.\n\nWhen enabled, methods in class-like structures are automatically reordered:\n1. Constructor (`__construct`) - always first\n2. Static methods (by visibility: public, protected, private)\n - Abstract methods before concrete methods\n - Alphabetically by name within each group\n3. Instance methods (by visibility: public, protected, private)\n - Abstract methods before concrete methods\n - Alphabetically by name within each group\n4. Other magic methods (e.g., `__toString`, `__get`, `__set`)\n - Sorted alphabetically by name\n5. Destructor (`__destruct`) - always last\n\nThis applies to all class-like structures: classes, traits, interfaces, and enums.\nOther members (constants, properties, trait uses, enum cases) remain in their original positions.\n\nDefault: false", + "type": "boolean" + }, + "sort-uses": { + "default": true, + "description": "Whether to sort use statements alphabetically.\n\nDefault: true", + "type": "boolean" + }, + "space-after-additive-unary-prefix-operator": { + "default": false, + "description": "Whether to add a space after the additive unary operators (+ and -).\n\nWhen enabled: `+ $i`\nWhen disabled: `+$i`\n\nDefault: false", + "type": "boolean" + }, + "space-after-bitwise-not-unary-prefix-operator": { + "default": false, + "description": "Whether to add a space after the bitwise not operator (~).\n\nWhen enabled: `~ $foo`\nWhen disabled: `~$foo`\n\nDefault: false", + "type": "boolean" + }, + "space-after-cast-unary-prefix-operators": { + "default": true, + "description": "Whether to add a space after cast operators (int, float, string, etc.).\n\nWhen enabled: `(int) $foo`\nWhen disabled: `(int)$foo`\n\nDefault: true", + "type": "boolean" + }, + "space-after-decrement-unary-prefix-operator": { + "default": false, + "description": "Whether to add a space after the decrement prefix operator (--).\n\nWhen enabled: `-- $i`\nWhen disabled: `--$i`\n\nDefault: false", + "type": "boolean" + }, + "space-after-error-control-unary-prefix-operator": { + "default": false, + "description": "Whether to add a space after the error control operator (@).\n\nWhen enabled: `@ $foo`\nWhen disabled: `@$foo`\n\nDefault: false", + "type": "boolean" + }, + "space-after-increment-unary-prefix-operator": { + "default": false, + "description": "Whether to add a space after the increment prefix operator (++).\n\nWhen enabled: `++ $i`\nWhen disabled: `++$i`\n\nDefault: false", + "type": "boolean" + }, + "space-after-logical-not-unary-prefix-operator": { + "default": false, + "description": "Whether to add a space after the logical not operator (!).\n\nWhen enabled: `! $foo`\nWhen disabled: `!$foo`\n\nDefault: false", + "type": "boolean" + }, + "space-after-reference-unary-prefix-operator": { + "default": false, + "description": "Whether to add a space after the reference operator (&).\n\nWhen enabled: `& $foo`\nWhen disabled: `&$foo`\n\nDefault: false", + "type": "boolean" + }, + "space-around-assignment-in-declare": { + "default": false, + "description": "Whether to add spaces around the assignment in declare statements.\n\nWhen enabled: `declare(strict_types = 1)`\nWhen disabled: `declare(strict_types=1)`\n\nDefault: false", + "type": "boolean" + }, + "space-around-concatenation-binary-operator": { + "default": true, + "description": "Whether to add spaces around the concatenation operator (.)\n\nWhen enabled: `$a . $b`\nWhen disabled: `$a.$b`\n\nDefault: true", + "type": "boolean" + }, + "space-before-arrow-function-parameter-list-parenthesis": { + "default": false, + "description": "Whether to add a space before the opening parameters in arrow functions.\n\nWhen enabled: `fn ($x) => $x * 2`\nWhen disabled: `fn($x) => $x * 2`\n\nDefault: false", + "type": "boolean" + }, + "space-before-closure-parameter-list-parenthesis": { + "default": true, + "description": "Whether to add a space before the opening parameters in closures.\n\nWhen enabled: `function ($x) use ($y)`\nWhen disabled: `function($x) use ($y)`\n\nDefault: true", + "type": "boolean" + }, + "space-before-closure-use-clause-parenthesis": { + "default": true, + "description": "Whether to add a space before the opening parenthesis in closure use clause.\n\nWhen enabled: `function() use ($var)`\nWhen disabled: `function() use($var)`\n\nDefault: true", + "type": "boolean" + }, + "space-before-hook-parameter-list-parenthesis": { + "default": false, + "description": "Whether to add a space before the opening parameters in hooks.\n\nWhen enabled: `$hook ($param)`\nWhen disabled: `$hook($param)`\n\nDefault: false", + "type": "boolean" + }, + "space-within-grouping-parenthesis": { + "default": false, + "description": "Whether to add spaces within grouping parentheses.\n\nWhen enabled: `( $expr ) - $expr`\nWhen disabled: `($expr) - $expr`\n\nDefault: false", + "type": "boolean" + }, + "tab-width": { + "default": 4, + "description": "Number of spaces per indentation level.\n\nDefault: 4", + "format": "uint", + "minimum": 0, + "type": "integer" + }, + "trailing-comma": { + "default": true, + "description": "Whether to add a trailing comma to the last element in multi-line syntactic structures.\n\nWhen enabled, trailing commas are added to lists, arrays, parameter lists,\nargument lists, and other similar structures when they span multiple lines.\n\nDefault: true", + "type": "boolean" + }, + "uppercase-literal-keyword": { + "default": false, + "description": "Whether to print boolean and null literals in upper-case (e.g. `TRUE`, `FALSE`, `NULL`).\nWhen enabled these literals are printed in uppercase; when disabled they are printed\nin lowercase.\n\nDefault: false", + "type": "boolean" + }, + "use-tabs": { + "default": false, + "description": "Whether to use tabs instead of spaces for indentation.\n\nDefault: false", + "type": "boolean" + } + }, + "title": "FormatterConfiguration", + "type": "object" + }, + "FormatterPreset": { + "description": "Available formatter presets.", + "type": "string" + }, + "GlobConfiguration": { + "additionalProperties": false, + "description": "Configuration for glob pattern matching behavior.\n\nThese settings control how glob patterns in `paths`, `includes`, and `excludes` are interpreted.\nAll defaults match standard glob behavior for backwards compatibility.", + "properties": { + "backslash-escape": { + "default": true, + "description": "Whether `\\` escapes special characters in patterns.\n\nDefault: `true`.", + "type": "boolean" + }, + "case-insensitive": { + "default": false, + "description": "Match patterns case-insensitively.\n\nDefault: `false`.", + "type": "boolean" + }, + "empty-alternates": { + "default": false, + "description": "Whether an empty case in alternates is allowed.\n\nWhen enabled, `{,a}` matches both `\"\"` and `\"a\"`.\n\nDefault: `false`.", + "type": "boolean" + }, + "literal-separator": { + "default": false, + "description": "When `true`, a single `*` does not match path separators (`/`).\n\nThis makes `src/*/Test` match only `src/foo/Test`, not `src/foo/bar/Test`.\nUse `**` for recursive matching across directories.\n\nDefault: `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GuardConfiguration": { + "additionalProperties": false, + "properties": { + "baseline": { + "default": null, + "description": "Path to a baseline file to ignore listed issues.", + "type": [ + "null", + "string" + ] + }, + "baseline-variant": { + "$ref": "#/$defs/BaselineVariant", + "default": "loose", + "description": "The baseline variant to use when generating new baselines.\n\nOptions:\n\n- `\"strict\"`: Exact line matching with start/end line numbers\n- `\"loose\"`: Count-based matching by (file, code, message) tuple (default)\n\nThe loose variant is more resilient to code changes as line number shifts\ndon't affect the baseline." + }, + "excludes": { + "default": [], + "description": "A list of patterns to exclude from guard checking.", + "items": { + "type": "string" + }, + "type": "array" + }, + "minimum-fail-level": { + "$ref": "#/$defs/Level", + "default": "Error", + "description": "Set the minimum issue severity that causes the command to fail.\n\nOptions: `\"note\"`, `\"help\"`, `\"warning\"`, `\"error\"`\n\nCan be overridden by the `--minimum-fail-level` CLI flag.\n\nDefaults to `\"error\"`." + }, + "mode": { + "$ref": "#/$defs/GuardMode", + "default": "default" + }, + "perimeter": { + "$ref": "#/$defs/PerimeterSettings", + "default": { + "layering": [], + "layers": {}, + "rules": [] + } + }, + "structural": { + "$ref": "#/$defs/StructuralSettings", + "default": { + "rules": [] + } + } + }, + "type": "object" + }, + "GuardMode": { + "description": "Specifies which guard modes to run.", + "oneOf": [ + { + "const": "default", + "description": "Run both structural and perimeter guards (default)", + "type": "string" + }, + { + "const": "structural", + "description": "Run only structural guard", + "type": "string" + }, + { + "const": "perimeter", + "description": "Run only perimeter guard", + "type": "string" + } + ] + }, + "IgnoreEntry": { + "anyOf": [ + { + "description": "Ignore a code everywhere: `\"code1\"`", + "type": "string" + }, + { + "description": "Ignore a code in specific paths or glob patterns:\n`{ code = \"code2\", in = [\"tests/\", \"src/**/*.php\"] }`", + "properties": { + "code": { + "type": "string" + }, + "in": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "code", + "in" + ], + "type": "object" + } + ], + "description": "Represents an entry in the analyzer's `ignore` configuration.\n\nCan be either a plain code string (ignored everywhere) or a scoped entry\nthat only ignores a code in specific paths. Scoped paths accept both\nplain directory/file prefixes (e.g. `\"tests/\"`, `\"src/Legacy.php\"`) and\nglob patterns (e.g. `\"src/**/*.php\"`); entries\ncontaining any of `*`, `?`, `[`, `{` are matched with [`ExclusionMatcher`]." + }, + "Level": { + "description": "Represents the severity level of an issue.", + "oneOf": [ + { + "const": "Note", + "description": "A note, providing additional information or context.", + "type": "string" + }, + { + "const": "Help", + "description": "A help message, suggesting possible solutions or further actions.", + "type": "string" + }, + { + "const": "Warning", + "description": "A warning, indicating a potential problem that may need attention.", + "type": "string" + }, + { + "const": "Error", + "description": "An error, indicating a problem that prevents the code from functioning correctly.", + "type": "string" + } + ] + }, + "LinterConfiguration": { + "additionalProperties": false, + "properties": { + "baseline": { + "default": null, + "description": "Path to a baseline file to ignore listed issues.", + "type": [ + "null", + "string" + ] + }, + "baseline-variant": { + "$ref": "#/$defs/BaselineVariant", + "default": "loose", + "description": "The baseline variant to use when generating new baselines.\n\nOptions:\n\n- `\"strict\"`: Exact line matching with start/end line numbers\n- `\"loose\"`: Count-based matching by (file, code, message) tuple (default)\n\nThe loose variant is more resilient to code changes as line number shifts\ndon't affect the baseline." + }, + "excludes": { + "default": [], + "description": "A list of patterns to exclude from linting.", + "items": { + "type": "string" + }, + "type": "array" + }, + "integrations": { + "default": [], + "description": "Integrations to enable during linting.", + "items": { + "type": "string" + }, + "type": "array" + }, + "minimum-fail-level": { + "$ref": "#/$defs/Level", + "default": "Error", + "description": "Set the minimum issue severity that causes the command to fail.\n\nOptions: `\"note\"`, `\"help\"`, `\"warning\"`, `\"error\"`\n\nCan be overridden by the `--minimum-fail-level` CLI flag.\n\nDefaults to `\"error\"`." + }, + "rules": { + "$ref": "#/$defs/RulesSettings", + "default": { + "ambiguous-constant-access": { + "enabled": false, + "level": "Help" + }, + "ambiguous-function-call": { + "enabled": false, + "level": "Help" + }, + "array-style": { + "enabled": true, + "level": "Note", + "style": "short" + }, + "assert-description": { + "enabled": true, + "level": "Warning" + }, + "assertion-style": { + "enabled": true, + "level": "Warning", + "style": "static" + }, + "block-statement": { + "enabled": true, + "level": "Note" + }, + "braced-string-interpolation": { + "enabled": true, + "level": "Note" + }, + "class-name": { + "enabled": true, + "level": "Help", + "psr": false + }, + "combine-consecutive-issets": { + "enabled": true, + "level": "Warning" + }, + "constant-condition": { + "enabled": true, + "level": "Help" + }, + "constant-name": { + "enabled": true, + "level": "Help" + }, + "cyclomatic-complexity": { + "enabled": true, + "level": "Error", + "method-threshold": null, + "threshold": 15 + }, + "deprecated-cast": { + "enabled": true, + "level": "Error" + }, + "deprecated-shell-execute-string": { + "enabled": true, + "level": "Error" + }, + "deprecated-switch-semicolon": { + "enabled": true, + "level": "Error" + }, + "disallowed-functions": { + "enabled": true, + "extensions": [], + "functions": [], + "level": "Warning" + }, + "disallowed-type-instantiation": { + "enabled": false, + "level": "Warning", + "types": [] + }, + "enum-name": { + "enabled": true, + "level": "Help" + }, + "excessive-nesting": { + "enabled": true, + "function-like-threshold": null, + "level": "Warning", + "threshold": 7 + }, + "excessive-parameter-list": { + "constructor-threshold": null, + "enabled": true, + "level": "Error", + "threshold": 5 + }, + "explicit-nullable-param": { + "enabled": true, + "level": "Warning" + }, + "explicit-octal": { + "enabled": true, + "level": "Warning" + }, + "file-name": { + "check-functions": false, + "enabled": true, + "level": "Warning" + }, + "final-controller": { + "enabled": true, + "level": "Error" + }, + "function-name": { + "camel": false, + "either": false, + "enabled": true, + "level": "Help" + }, + "halstead": { + "difficulty-threshold": 12, + "effort-threshold": 5000, + "enabled": true, + "level": "Warning", + "volume-threshold": 1000 + }, + "identity-comparison": { + "enabled": true, + "level": "Warning" + }, + "ineffective-format-ignore-next": { + "enabled": true, + "level": "Warning" + }, + "ineffective-format-ignore-region": { + "enabled": true, + "level": "Warning" + }, + "inline-variable-return": { + "enabled": true, + "level": "Warning" + }, + "instanceof-stringable": { + "enabled": true, + "level": "Warning" + }, + "interface-name": { + "enabled": true, + "level": "Help", + "psr": false + }, + "invalid-open-tag": { + "enabled": true, + "level": "Note" + }, + "kan-defect": { + "enabled": true, + "level": "Error", + "threshold": 1.6 + }, + "literal-named-argument": { + "check-first-argument": false, + "enabled": true, + "level": "Warning", + "threshold": 1 + }, + "loop-does-not-iterate": { + "enabled": true, + "level": "Warning" + }, + "lowercase-keyword": { + "enabled": true, + "level": "Help" + }, + "lowercase-type-hint": { + "enabled": true, + "level": "Help" + }, + "method-name": { + "camel": true, + "either": false, + "enabled": false, + "level": "Help", + "use-snake-case-for-tests": false + }, + "middleware-in-routes": { + "enabled": true, + "level": "Warning" + }, + "missing-docs": { + "classes": false, + "constants": true, + "enabled": false, + "enum-cases": true, + "enums": false, + "functions": true, + "interfaces": false, + "level": "Help", + "methods": true, + "properties": true, + "statics": true, + "traits": false + }, + "no-alias-function": { + "enabled": true, + "level": "Note" + }, + "no-alternative-syntax": { + "enabled": false, + "level": "Warning" + }, + "no-array-accumulation-in-loop": { + "enabled": false, + "level": "Warning" + }, + "no-assign-in-argument": { + "enabled": false, + "level": "Warning" + }, + "no-assign-in-condition": { + "enabled": true, + "level": "Warning" + }, + "no-boolean-flag-parameter": { + "enabled": true, + "exclude-constructors": true, + "exclude-setters": false, + "level": "Help" + }, + "no-closing-tag": { + "enabled": true, + "level": "Help" + }, + "no-db-schema-change": { + "enabled": true, + "level": "Error" + }, + "no-dead-store": { + "enabled": false, + "level": "Warning" + }, + "no-debug-symbols": { + "enabled": true, + "level": "Note" + }, + "no-direct-db-query": { + "enabled": true, + "level": "Warning" + }, + "no-else-clause": { + "enabled": true, + "level": "Help" + }, + "no-empty": { + "enabled": true, + "level": "Error" + }, + "no-empty-catch-clause": { + "enabled": true, + "level": "Warning" + }, + "no-empty-comment": { + "enabled": true, + "level": "Note", + "preserve-single-line-comments": false + }, + "no-empty-loop": { + "enabled": true, + "level": "Note" + }, + "no-error-control-operator": { + "enabled": true, + "level": "Error" + }, + "no-eval": { + "enabled": true, + "level": "Error" + }, + "no-ffi": { + "enabled": true, + "level": "Error" + }, + "no-fully-qualified-global-class-like": { + "enabled": false, + "level": "Help" + }, + "no-fully-qualified-global-constant": { + "enabled": false, + "level": "Help" + }, + "no-fully-qualified-global-function": { + "enabled": false, + "level": "Help" + }, + "no-global": { + "enabled": true, + "level": "Error" + }, + "no-goto": { + "enabled": true, + "level": "Note" + }, + "no-hash-comment": { + "enabled": true, + "level": "Warning" + }, + "no-hash-emoji": { + "enabled": true, + "level": "Warning" + }, + "no-ini-set": { + "enabled": true, + "level": "Warning" + }, + "no-inline": { + "enabled": false, + "level": "Error" + }, + "no-insecure-comparison": { + "enabled": true, + "level": "Error" + }, + "no-is-null": { + "enabled": false, + "level": "Note" + }, + "no-isset": { + "allow-array-checks": false, + "enabled": true, + "level": "Warning" + }, + "no-iterator-to-array-in-foreach": { + "enabled": false, + "level": "Warning" + }, + "no-literal-namespace-string": { + "enabled": false, + "level": "Warning" + }, + "no-literal-password": { + "enabled": true, + "level": "Error" + }, + "no-multi-assignments": { + "enabled": true, + "level": "Warning" + }, + "no-negated-ternary": { + "enabled": false, + "level": "Help" + }, + "no-nested-ternary": { + "enabled": true, + "level": "Warning" + }, + "no-noop": { + "enabled": true, + "level": "Help" + }, + "no-null-property-init": { + "enabled": false, + "level": "Help" + }, + "no-only": { + "enabled": true, + "level": "Error" + }, + "no-parameter-shadowing": { + "enabled": false, + "level": "Warning" + }, + "no-php-tag-terminator": { + "enabled": true, + "level": "Note" + }, + "no-protected-in-final": { + "enabled": true, + "level": "Help" + }, + "no-redundant-binary-string-prefix": { + "enabled": true, + "level": "Help" + }, + "no-redundant-block": { + "enabled": true, + "level": "Help" + }, + "no-redundant-continue": { + "enabled": true, + "level": "Help" + }, + "no-redundant-else": { + "enabled": false, + "level": "Help" + }, + "no-redundant-file": { + "enabled": true, + "level": "Help" + }, + "no-redundant-final": { + "enabled": true, + "level": "Help" + }, + "no-redundant-isset": { + "enabled": true, + "level": "Help" + }, + "no-redundant-label": { + "enabled": true, + "level": "Help" + }, + "no-redundant-literal-return": { + "enabled": true, + "level": "Warning" + }, + "no-redundant-math": { + "enabled": true, + "level": "Help" + }, + "no-redundant-method-override": { + "enabled": true, + "level": "Help" + }, + "no-redundant-nullsafe": { + "enabled": true, + "level": "Help" + }, + "no-redundant-parentheses": { + "enabled": true, + "level": "Help" + }, + "no-redundant-readonly": { + "enabled": true, + "level": "Help" + }, + "no-redundant-string-concat": { + "enabled": true, + "level": "Help" + }, + "no-redundant-use": { + "enabled": true, + "level": "Warning" + }, + "no-redundant-variable": { + "enabled": false, + "level": "Warning" + }, + "no-redundant-write-visibility": { + "enabled": true, + "level": "Help" + }, + "no-redundant-yield-from": { + "enabled": true, + "level": "Help" + }, + "no-request-all": { + "enabled": true, + "level": "Warning" + }, + "no-request-variable": { + "enabled": true, + "level": "Error" + }, + "no-roles-as-capabilities": { + "enabled": true, + "level": "Warning" + }, + "no-self-assignment": { + "enabled": true, + "level": "Warning" + }, + "no-service-state-mutation": { + "allowed-methods": [ + "__construct", + "reset" + ], + "enabled": false, + "exclude-namespaces": [ + "App\\DTO\\", + "App\\Entity\\", + "App\\ValueObject\\" + ], + "include-namespaces": [ + "App\\" + ], + "level": "Warning", + "reset-interfaces": [ + "Symfony\\Contracts\\Service\\ResetInterface" + ] + }, + "no-shell-execute-string": { + "enabled": true, + "level": "Error" + }, + "no-short-bool-cast": { + "enabled": false, + "level": "Help" + }, + "no-short-opening-tag": { + "enabled": true, + "level": "Warning" + }, + "no-shorthand-ternary": { + "enabled": true, + "level": "Warning" + }, + "no-side-effects-with-declarations": { + "allow-class-alias": true, + "allow-class-exists": true, + "allow-conditional-declarations": true, + "enabled": false, + "level": "Warning" + }, + "no-sprintf-concat": { + "enabled": true, + "level": "Warning" + }, + "no-trailing-space": { + "enabled": true, + "level": "Note" + }, + "no-underscore-class": { + "enabled": true, + "level": "Warning" + }, + "no-unescaped-output": { + "enabled": true, + "level": "Error" + }, + "no-unsafe-finally": { + "enabled": true, + "level": "Error" + }, + "no-unused-closure-capture": { + "enabled": false, + "level": "Warning" + }, + "no-unused-global": { + "enabled": false, + "level": "Warning" + }, + "no-unused-static": { + "enabled": false, + "level": "Warning" + }, + "no-variable-variable": { + "enabled": true, + "level": "Warning" + }, + "no-void-reference-return": { + "enabled": true, + "level": "Warning" + }, + "optional-param-order": { + "enabled": true, + "level": "Warning" + }, + "prefer-anonymous-migration": { + "enabled": true, + "level": "Warning" + }, + "prefer-arrow-function": { + "enabled": true, + "level": "Help" + }, + "prefer-early-continue": { + "enabled": true, + "level": "Help", + "max_allowed_statements": 0 + }, + "prefer-explode-over-preg-split": { + "enabled": false, + "level": "Warning" + }, + "prefer-first-class-callable": { + "check-functions": false, + "enabled": true, + "level": "Warning" + }, + "prefer-interface": { + "enabled": true, + "level": "Note" + }, + "prefer-pre-increment": { + "enabled": false, + "level": "Help" + }, + "prefer-self-return-type": { + "enabled": false, + "level": "Help" + }, + "prefer-static-closure": { + "enabled": true, + "level": "Help" + }, + "prefer-test-attribute": { + "enabled": false, + "level": "Warning" + }, + "prefer-view-array": { + "enabled": true, + "level": "Help" + }, + "prefer-while-loop": { + "enabled": true, + "level": "Note" + }, + "property-name": { + "camel": true, + "either": false, + "enabled": false, + "level": "Help" + }, + "psl-array-functions": { + "enabled": true, + "level": "Warning" + }, + "psl-data-structures": { + "enabled": true, + "level": "Warning" + }, + "psl-datetime": { + "enabled": true, + "level": "Warning" + }, + "psl-math-functions": { + "enabled": true, + "level": "Warning" + }, + "psl-output": { + "enabled": true, + "level": "Error" + }, + "psl-randomness-functions": { + "enabled": true, + "level": "Warning" + }, + "psl-regex-functions": { + "enabled": true, + "level": "Warning" + }, + "psl-sleep-functions": { + "enabled": true, + "level": "Warning" + }, + "psl-string-functions": { + "enabled": true, + "level": "Warning" + }, + "readable-literal": { + "enabled": true, + "level": "Warning", + "min-digits": 5 + }, + "require-namespace": { + "enabled": false, + "level": "Warning" + }, + "require-preg-quote-delimiter": { + "enabled": true, + "level": "Warning" + }, + "sensitive-parameter": { + "enabled": true, + "level": "Error" + }, + "single-class-per-file": { + "enabled": true, + "level": "Warning" + }, + "sorted-integer-keys": { + "enabled": false, + "level": "Help" + }, + "str-contains": { + "enabled": true, + "level": "Warning" + }, + "str-starts-with": { + "enabled": true, + "level": "Warning" + }, + "strict-assertions": { + "enabled": true, + "level": "Warning" + }, + "strict-behavior": { + "allow-loose-behavior": false, + "enabled": true, + "level": "Warning" + }, + "strict-types": { + "allow-disabling": false, + "enabled": true, + "level": "Warning" + }, + "string-style": { + "enabled": false, + "level": "Note", + "style": "interpolation" + }, + "switch-continue-to-break": { + "enabled": false, + "level": "Warning" + }, + "tagged-fixme": { + "enabled": true, + "level": "Warning" + }, + "tagged-todo": { + "enabled": true, + "level": "Warning" + }, + "tainted-data-to-sink": { + "enabled": true, + "known-sink-functions": [ + "printf" + ], + "level": "Error" + }, + "too-many-enum-cases": { + "enabled": true, + "level": "Error", + "threshold": 20 + }, + "too-many-methods": { + "count-hooks": false, + "count-setters-and-getters": false, + "enabled": true, + "level": "Error", + "threshold": 10 + }, + "too-many-properties": { + "enabled": true, + "level": "Error", + "threshold": 10 + }, + "trait-name": { + "enabled": true, + "level": "Help", + "psr": false + }, + "use-compound-assignment": { + "enabled": true, + "level": "Help" + }, + "use-dedicated-expectation": { + "enabled": true, + "level": "Warning" + }, + "use-simpler-expectation": { + "enabled": true, + "level": "Warning" + }, + "use-specific-assertions": { + "enabled": true, + "level": "Warning" + }, + "use-specific-expectations": { + "enabled": true, + "level": "Warning" + }, + "use-wp-functions": { + "enabled": true, + "level": "Warning" + }, + "valid-docblock": { + "enabled": true, + "level": "Note" + }, + "variable-name": { + "camel": false, + "check-parameters": true, + "either": true, + "enabled": false, + "level": "Help" + }, + "yoda-conditions": { + "enabled": false, + "level": "Help" + } + }, + "description": "Settings for various linting rules." + } + }, + "type": "object" + }, + "MethodChainBreakingStyle": { + "enum": [ + "next_line", + "same_line" + ], + "type": "string" + }, + "NullTypeHint": { + "description": "Specifies null type hint style.", + "enum": [ + "null_pipe", + "null_pipe_last", + "question" + ], + "type": "string" + }, + "PHPVersion": { + "description": "Represents a PHP version in `(major, minor, patch)` format,\npacked internally into a single `u32` for easy comparison.\n\n# Examples\n\n```\nuse mago_php_version::PHPVersion;\n\nlet version = PHPVersion::new(8, 4, 0);\nassert_eq!(version.major(), 8);\nassert_eq!(version.minor(), 4);\nassert_eq!(version.patch(), 0);\nassert_eq!(version.to_version_id(), 0x08_04_00);\nassert_eq!(version.to_string(), \"8.4.0\");\n```", + "type": "string" + }, + "ParserConfiguration": { + "additionalProperties": false, + "description": "Configuration for the PHP parser.\n\nControls how PHP code is parsed, including lexer-level settings\nthat affect tokenization behavior.", + "properties": { + "enable-short-tags": { + "default": true, + "description": "Whether to enable PHP short open tags (`) from files. -remove-trailing-close-tag = true -# Prefer single quotes over double quotes for strings. -single-quote = true -# Number of spaces per indentation level. -tab-width = 4 -# Add a trailing comma to multi-line arrays, parameter lists, etc. -trailing-comma = true -# Use tabs instead of spaces for indentation. -use-tabs = false -# Place empty control structure bodies on the same line. -inline-empty-control-braces = true -# Place empty function bodies on the same line. -inline-empty-function-braces = true -# Place empty constructor bodies on the same line. -inline-empty-constructor-braces = true -# Place empty method bodies on the same line. -inline-empty-method-braces = true -# Place empty anonymous class bodies on the same line. -inline-empty-anonymous-class-braces = true -# How to break method chains. -method-chain-breaking-style = "next_line" -# Preserve existing line breaks in method chains. -preserve-breaking-member-access-chain = false -# Preserve existing line breaks in argument lists. -preserve-breaking-argument-list = false -# Preserve existing line breaks in array-like structures. -preserve-breaking-array-like = false -# Preserve existing line breaks in parameter lists. -preserve-breaking-parameter-list = false -# Preserve existing line breaks in attribute lists. -preserve-breaking-attribute-list = false -# Preserve existing line breaks in ternary expressions. -preserve-breaking-conditional-expression = false -# Always break parameter lists with promoted properties. -break-promoted-properties-list = true -# Place the binary operator on the next line when breaking. -line-before-binary-operator = true -# Always break named argument lists into multiple lines. -always-break-named-arguments-list = true -# Always break named argument lists in attributes. -always-break-attribute-named-argument-lists = true -# Use table-style alignment for arrays. -array-table-style-alignment = true -# Sort use statements alphabetically. -sort-uses = true -# Insert a blank line between different types of use statements. -separate-use-types = true -# Expand grouped use statements into individual statements. -expand-use-groups = true -# How to format null type hints (null|T vs ?T). -null-type-hint = "null_pipe" -# Add parentheses around new in member access ((new Foo)->bar()). -parentheses-around-new-in-member-access = false -# Add parentheses to new expressions without arguments (new Foo()). -parentheses-in-new-expression = true -# Add parentheses to exit and die constructs. -parentheses-in-exit-and-die = true -# Add parentheses to attributes without arguments. -parentheses-in-attribute = true -# Add a space before arrow function parameters. -space-before-arrow-function-parameter-list-parenthesis = false + 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"] + workspace = "." [linter] -integrations = ["wordpress"] + integrations = ["wordpress"] -[linter.rules] -ambiguous-function-call = { enabled = true } -halstead = { effort-threshold = 7000 } -literal-named-argument = { enabled = false } -no-redundant-readonly = { enabled = true } -no-redundant-use = { enabled = true } -no-variable-variable = { enabled = true } + [linter.rules] + ambiguous-function-call = { enabled = true } + array-style = { enabled = true, style = "short" } + halstead = { effort-threshold = 7000 } + literal-named-argument = { enabled = false } + missing-docs = { enabled = true } + no-array-accumulation-in-loop = { enabled = true } + no-inline = { enabled = true } + no-is-null = { enabled = true } + no-iterator-to-array-in-foreach = { enabled = true } + no-parameter-shadowing = { enabled = true } + no-redundant-readonly = { enabled = true } + no-redundant-use = { enabled = true } + no-variable-variable = { enabled = true } + require-namespace = { enabled = true } + sorted-integer-keys = { enabled = true } + # Les else permettent de conserver les branches d'une condition à la même indentation. + no-else-clause = { enabled = false } [analyzer] -allow-possibly-undefined-array-keys = true -analyze-dead-code = true -check-arrow-function-missing-type-hints = true -check-closure-missing-type-hints = true -check-missing-type-hints = true -check-throws = true -find-unused-definitions = true -find-unused-expressions = true -perform-heuristic-checks = true -strict-list-index-checks = true + allow-implicit-pipe-callable-types = false + allow-possibly-undefined-array-keys = false + allow-side-effects-in-conditions = true + analyze-dead-code = true + check-arrow-function-missing-type-hints = true + check-closure-missing-type-hints = true + check-experimental = true + check-missing-override = true + check-missing-type-hints = true + check-name-casing = true + check-property-initialization = true + check-throws = true + check-use-statements = true + enforce-class-finality = true + find-overly-wide-return-types = true + find-unused-definitions = true + find-unused-expressions = true + find-unused-parameters = true + memoize-properties = true + no-boolean-literal-comparison = false + perform-heuristic-checks = true + plugins = ["psl"] + require-api-or-internal = true + strict-list-index-checks = true + trust-existence-checks = false + + [analyzer.performance] + array-combination-threshold = 256 + consensus-limit-threshold = 512 + disjunction-complexity-threshold = 8192 + formula-size-threshold = 1024 + integer-combination-threshold = 256 + loop-assignment-depth-threshold = 2 + negation-complexity-threshold = 8192 + saturation-complexity-threshold = 16384 + string-combination-threshold = 256 + +[formatter] + excludes = [ + "web/app/mu-plugins", + "web/app/plugins", + ] diff --git a/mise.toml b/mise.toml index a1d0dc78..d2d9db14 100644 --- a/mise.toml +++ b/mise.toml @@ -1,2 +1,2 @@ [tools] -"cargo:mago" = "latest" + "github:AJenbo/phpantom_lsp" = "latest" diff --git a/package.json b/package.json old mode 100755 new mode 100644 index e28dd766..cf80f947 --- a/package.json +++ b/package.json @@ -7,63 +7,68 @@ "license": "ISC", "main": "index.js", "keywords": [], - "scripts": { "knip": "knip" }, + "scripts": { + "knip": "knip", + "prepare": "effect-tsgo patch" + }, "dependencies": { - "@effect/language-service": "^0.60.0", - "@logtape/logtape": "^1.2.2", "@mobily/ts-belt": "v4.0.0-rc.5", - "@sentry/browser": "^10.29.0", - "a11y-dialog": "^8.1.4", - "chalk": "^5.6.2", - "effect": "^3.19.9", - "lit-html": "^3.3.1", - "loglevel": "^1.9.2", - "loglevel-plugin-prefix": "^0.8.4", - "optics-ts": "^2.4.1", + "@sentry/browser": "^10.51.0", + "a11y-dialog": "^8.1.5", + "effect": "^4.0.0-beta.59", + "html-template-tag": "^5.0.0", + "lit-html": "^3.3.2", "purify-ts": "2.1.2", "ts-pattern": "^5.9.0", "valibot": "1.1.0" }, "devDependencies": { - "@biomejs/biome": "^2.3.8", - "@cspell/dict-fr-fr": "^2.3.2", - "@eslint/js": "^9.39.1", - "@playwright/test": "^1.57.0", - "@prettier/plugin-xml": "^3.4.2", - "@sentry/core": "^10.29.0", - "@swc/cli": "0.7.8", - "@types/eslint__js": "^9.14.0", - "@types/node": "^24.10.1", - "@vitejs/plugin-legacy": "^7.2.1", + "@effect/language-service": "^0.85.1", + "@effect/tsgo": "^0.5.2", + "@gcch/configuration-eslint": "git+https://git.gcch.fr/gcch/configuration-eslint#888eb4aa54", + "@gcch/configuration-oxlint": "git+https://git.gcch.fr/gcch/configuration-oxlint#83547fc1ebfd", + "@gcch/configuration-prettier": "git+https://git.gcch.fr/gcch/configuration-prettier#d267d6dc5e", + "@playwright/test": "^1.59.1", + "@sentry/core": "^10.51.0", + "@types/bun": "^1.3.13", + "@types/node": "^25.6.0", + "@typescript/native-preview": "7.0.0-dev.20260503.1", + "@vitejs/plugin-legacy": "^8.0.1", "better-typescript-lib": "^2.12.0", - "browserslist": "^4.28.1", - "caniuse-lite": "^1.0.30001759", - "eslint": "^9.39.1", - "eslint-plugin-oxlint": "^1.31.0", - "eslint-plugin-perfectionist": "^4.15.1", + "browserslist": "^4.28.2", + "caniuse-lite": "^1.0.30001791", + "eslint": "^10.3.0", + "eslint-plugin-functional": "^9.0.4", + "eslint-plugin-jsx-a11y": "^6.10.2", + "eslint-plugin-oxlint": "^1.62.0", + "eslint-plugin-perfectionist": "^5.9.0", "fdir": "^6.5.0", - "globals": "^16.5.0", - "knip": "^5.71.0", - "lightningcss-cli": "^1.30.2", - "oxlint": "^1.31.0", - "picomatch": "^4.0.3", - "playwright": "^1.57.0", - "prettier": "^4.0.0-alpha.13", - "prettier-plugin-pkg": "^0.21.2", - "prettier-plugin-sh": "^0.18.0", - "sass-embedded": "^1.93.3", - "stylelint": "^16.26.1", - "stylelint-config-clean-order": "^8.0.0", - "stylelint-config-sass-guidelines": "^12.1.0", - "stylelint-config-standard-scss": "^16.0.0", - "stylelint-declaration-block-no-ignored-properties": "^2.8.0", - "stylelint-plugin-logical-css": "^1.2.3", - "typescript": "5.9.3", - "typescript-eslint": "^8.48.1", - "vite": "^7.2.6", - "vite-plugin-valibot-env": "^1.0.1", - "vite-tsconfig-paths": "^5.1.4", - "wp-types": "^4.69.0" + "globals": "^17.6", + "jiti": "^2.6.1", + "knip": "^6.11.0", + "lightningcss": "^1.32.0", + "lightningcss-cli": "^1.32.0", + "oxlint": "^1.62.0", + "oxlint-tsgolint": "^0.22.1", + "playwright": "^1.59.1", + "prettier": "^3.8.3", + "prettier-plugin-curly": "^0.4.1", + "prettier-plugin-ini": "^1.3.0", + "prettier-plugin-jsdoc": "^1.8.0", + "prettier-plugin-pkg": "^0.22.1", + "prettier-plugin-sh": "^0.18.1", + "prettier-plugin-sort-json": "^4.2.0", + "sass-embedded": "^1.99.0", + "stylelint": "^17.9.1", + "stylelint-config-clean-order": "^8.0.1", + "stylelint-config-sass-guidelines": "^13.0.0", + "stylelint-config-standard-scss": "^17.0.0", + "stylelint-declaration-block-no-ignored-properties": "^3.0.0", + "stylelint-plugin-logical-css": "^2.1.0", + "typescript": "^6.0.3", + "typescript-eslint": "^8.59.1", + "vite": "^8.0.10", + "vite-tsconfig-paths": "^6.1.1" }, "browserslist": [ "chrome >0 and last 3 years", @@ -75,8 +80,17 @@ "ios >0 and last 3 years" ], "knip": { - "entry": ["web/app/themes/haiku-atelier-2024/src/scripts/*.ts"], - "project": ["web/app/themes/haiku-atelier-2024/src/scripts/**/*.{js,ts,d.ts}"] + "entry": [ + "web/app/themes/haiku-atelier-2024/src/scripts/*.ts" + ], + "project": [ + "web/app/themes/haiku-atelier-2024/src/scripts/**/*.{js,ts,d.ts}" + ] }, - "trustedDependencies": ["@biomejs/biome", "@parcel/watcher", "@swc/core", "core-js", "esbuild", "lightningcss-cli"] + "trustedDependencies": [ + "@parcel/watcher", + "core-js", + "lightningcss-cli", + "msgpackr-extract" + ] } diff --git a/phpactor.schema.json b/phpactor.schema.json index 1fa4c010..0b95e93e 100644 --- a/phpactor.schema.json +++ b/phpactor.schema.json @@ -1,492 +1,773 @@ { - "$schema": "https:\/\/json-schema.org\/draft-07\/schema", - "title": "Phpactor Configuration Schema", - "type": "object", + "$schema": "https://json-schema.org/draft-07/schema", "properties": { "$schema": { - "description": "Path to JSON schema, which can be used for config autocompletion, use phpactor config:initialize to update", - "default": "" + "default": "", + "description": "Path to JSON schema, which can be used for config autocompletion, use phpactor config:initialize to update" }, - "console_dumper_default": { - "description": "Name of the \"dumper\" (renderer) to use for some CLI commands", - "default": "indented" - }, - "xdebug_disable": { "description": "If XDebug should be automatically disabled", "default": true }, - "command": { "description": "Internal use only - name of the command which was executed" }, - "core.min_memory_limit": { - "description": "Ensure that PHP has a memory_limit of at least this amount in bytes", - "default": 1610612736 - }, - "class_to_file.project_root": { - "description": "Root path of the project (e.g. where composer.json is)", - "default": "%project_root%" - }, - "class_to_file.brute_force_conversion": { - "description": "If composer not found, fallback to scanning all files (very time consuming depending on project size)", - "default": true - }, - "code_transform.class_new.variants": { - "description": "Variants which should be suggested when class-create is invoked", - "default": [] - }, - "code_transform.template_paths": { - "description": "Paths in which to look for code templates", - "default": ["%project_config%\/templates", "%config%\/templates"] - }, - "code_transform.indentation": { - "description": "Indentation chars to use in code generation and transformation", - "default": " " - }, - "code_transform.refactor.generate_accessor.prefix": { - "description": "Prefix to use for generated accessors", - "default": "" - }, - "code_transform.refactor.generate_accessor.upper_case_first": { - "description": "If the first letter of a generated accessor should be made uppercase", - "default": false - }, - "code_transform.refactor.generate_mutator.prefix": { - "description": "Prefix to use for generated mutators", - "default": "set" - }, - "code_transform.refactor.generate_mutator.upper_case_first": { - "description": "If the first letter of a generated mutator should be made uppercase", - "default": true - }, - "code_transform.refactor.generate_mutator.fluent": { - "description": "If the mutator should be fluent", - "default": false - }, - "code_transform.import_globals": { - "description": "Import functions even if they are in the global namespace", - "default": false - }, - "code_transform.refactor.object_fill.hint": { - "description": "Object fill refactoring: show hint as a comment", - "default": true - }, - "code_transform.refactor.object_fill.named_parameters": { - "description": "Object fill refactoring: use named parameters", - "default": true - }, - "completion_worse.completor.doctrine_annotation.enabled": { - "description": "Enable or disable the ``doctrine_annotation`` completor.\n\nCompletion for annotations provided by the Doctrine annotation library.", - "default": true - }, - "completion_worse.completor.imported_names.enabled": { - "description": "Enable or disable the ``imported_names`` completor.\n\nCompletion for names imported into the current namespace.", - "default": true - }, - "completion_worse.completor.worse_parameter.enabled": { - "description": "Enable or disable the ``worse_parameter`` completor.\n\nCompletion for method or function parameters.", - "default": true - }, - "completion_worse.completor.named_parameter.enabled": { - "description": "Enable or disable the ``named_parameter`` completor.\n\nCompletion for named parameters.", - "default": true - }, - "completion_worse.completor.constructor.enabled": { - "description": "Enable or disable the ``constructor`` completor.\n\nCompletion for constructors.", - "default": true - }, - "completion_worse.completor.class_member.enabled": { - "description": "Enable or disable the ``class_member`` completor.\n\nCompletion for class members.", - "default": true - }, - "completion_worse.completor.scf_class.enabled": { - "description": "Enable or disable the ``scf_class`` completor.\n\nBrute force completion for class names (not recommended).", - "default": true - }, - "completion_worse.completor.local_variable.enabled": { - "description": "Enable or disable the ``local_variable`` completor.\n\nCompletion for local variables.", - "default": true - }, - "completion_worse.completor.subscript.enabled": { - "description": "Enable or disable the ``subscript`` completor.\n\nCompletion for subscript (array access from array shapes).", - "default": true - }, - "completion_worse.completor.declared_function.enabled": { - "description": "Enable or disable the ``declared_function`` completor.\n\nCompletion for functions defined in the Phpactor runtime.", - "default": true - }, - "completion_worse.completor.declared_constant.enabled": { - "description": "Enable or disable the ``declared_constant`` completor.\n\nCompletion for constants defined in the Phpactor runtime.", - "default": true - }, - "completion_worse.completor.declared_class.enabled": { - "description": "Enable or disable the ``declared_class`` completor.\n\nCompletion for classes defined in the Phpactor runtime.", - "default": true - }, - "completion_worse.completor.expression_name_search.enabled": { - "description": "Enable or disable the ``expression_name_search`` completor.\n\nCompletion for class names, constants and functions at expression positions that are located in the index.", - "default": true - }, - "completion_worse.completor.use.enabled": { - "description": "Enable or disable the ``use`` completor.\n\nCompletion for use imports.", - "default": true - }, - "completion_worse.completor.attribute.enabled": { - "description": "Enable or disable the ``attribute`` completor.\n\nCompletion for attribute class names.", - "default": true - }, - "completion_worse.completor.class_like.enabled": { - "description": "Enable or disable the ``class_like`` completor.\n\nCompletion for class like contexts.", - "default": true - }, - "completion_worse.completor.type.enabled": { - "description": "Enable or disable the ``type`` completor.\n\nCompletion for scalar types.", - "default": true - }, - "completion_worse.completor.keyword.enabled": { - "description": "Enable or disable the ``keyword`` completor.\n\nCompletion for keywords (not very accurate).", - "default": true - }, - "completion_worse.completor.docblock.enabled": { - "description": "Enable or disable the ``docblock`` completor.\n\nDocblock completion.", - "default": true - }, - "completion_worse.completor.constant.enabled": { "description": null, "default": false }, - "completion_worse.completor.class.limit": { - "description": "Suggestion limit for the filesystem based SCF class_completor", - "default": 100 - }, - "completion_worse.name_completion_priority": { - "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.", - "default": "proximity" - }, - "completion_worse.snippets": { "description": "Enable or disable completion snippets", "default": true }, - "completion_worse.experimantal": { "description": "Enable experimental functionality", "default": false }, - "completion_worse.debug": { "description": "Include debug info in completion results", "default": false }, - "completion.dedupe": { "description": "If results should be de-duplicated", "default": true }, - "completion.dedupe_match_fqn": { - "description": "If ``completion.dedupe``, consider the class FQN in addition to the completion suggestion", - "default": true - }, - "completion.limit": { "description": "Sets a limit on the number of completion suggestions for any request" }, - "completion.label_formatter": { - "description": "Definition of how to format entries in the completion list", - "default": "helpful", - "enum": ["helpful", "fqn"] - }, - "navigator.destinations": { "description": null, "default": [] }, - "navigator.autocreate": { "description": null, "default": [] }, - "rpc.store_replay": { "description": "Should replays be stored?", "default": false }, - "rpc.replay_path": { "description": "Path where the replays should be stored", "default": "%cache%\/replay.json" }, - "source_code_filesystem.project_root": { "description": null, "default": "%project_root%" }, - "language_server_code_transform.import_globals": { - "description": "Show hints for non-imported global classes and functions", - "default": false - }, - "worse_reflection.enable_cache": { "description": "If reflection caching should be enabled", "default": true }, - "worse_reflection.cache_lifetime": { - "description": "If caching is enabled, limit the amount of time a cache entry can stay alive", - "default": 1 - }, - "worse_reflection.enable_context_location": { - "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)", - "default": true - }, - "worse_reflection.cache_dir": { - "description": "Cache directory for stubs", - "default": "%cache%\/worse-reflection" - }, - "worse_reflection.stub_dir": { - "description": "Location of the core PHP stubs - these will be scanned and cached on the first request", - "default": "%application_root%\/vendor\/jetbrains\/phpstorm-stubs" - }, - "worse_reflection.diagnostics.undefined_variable.suggestion_levenshtein_disatance": { - "description": "Levenshtein distance to use when suggesting corrections for variable names", - "type": ["integer"], - "default": 4 - }, - "file_path_resolver.project_root": { "description": null, "default": "\/opt\/phpactor" }, - "file_path_resolver.app_name": { "description": null, "default": "phpactor" }, - "file_path_resolver.application_root": { "description": null }, - "file_path_resolver.enable_cache": { "description": null, "default": true }, - "file_path_resolver.enable_logging": { "description": null, "default": true }, - "logging.enabled": { "description": null, "type": ["boolean"], "default": false }, - "logging.fingers_crossed": { "description": null, "type": ["boolean"], "default": false }, - "logging.path": { "description": null, "type": ["string"], "default": "application.log" }, - "logging.level": { - "description": null, - "type": ["string"], - "default": "warning", - "enum": ["emergency", "alert", "critical", "error", "warning", "notice", "info", "debug"] - }, - "logger.name": { "description": null, "type": ["string"], "default": "logger" }, - "logging.formatter": { "description": null }, - "composer.enable": { - "description": "Include of the projects autoloader to facilitate class location. Note that when including an autoloader code _may_ be executed. This option may be disabled when using the indexer", - "default": true - }, - "composer.autoloader_path": { - "description": "Path to project's autoloader, can be an array", - "default": "%project_root%\/vendor\/autoload.php" - }, - "composer.autoload_deregister": { - "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", - "default": true - }, - "composer.class_maps_only": { - "description": "Register the composer class maps only, do not register the autoloader - RECOMMENDED", - "default": true - }, - "console.verbosity": { "description": "Verbosity level", "default": 32, "enum": [16, 32, 64, 128, 256] }, - "console.decorated": { - "description": "Whether to decorate messages (null for auto-guessing)", - "enum": [true, false, null] - }, - "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." - }, - "language_server.catch_errors": { "description": null, "default": true }, - "language_server.enable_workspace": { - "description": "If workspace management \/ text synchronization should be enabled (this isn't required for some language server implementations, e.g. static analyzers)", - "default": true - }, - "language_server.session_parameters": { - "description": "Phpactor parameters (config) that apply only to the language server session", - "default": [] - }, - "language_server.method_alias_map": { - "description": "Allow method names to be re-mapped. Useful for maintaining backwards compatibility", - "default": [] - }, - "language_server.diagnostic_sleep_time": { - "description": "Amount of time to wait before analyzing the code again for diagnostics", - "default": 1000 - }, - "language_server.diagnostics_on_update": { - "description": "Perform diagnostics when the text document is updated", - "default": true - }, - "language_server.diagnostics_on_save": { - "description": "Perform diagnostics when the text document is saved", - "default": true - }, - "language_server.diagnostics_on_open": { - "description": "Perform diagnostics when opening a text document", - "default": true - }, - "language_server.diagnostic_providers": { - "description": "Specify which diagnostic providers should be active (default to all)" - }, - "language_server.diagnostic_outsource": { - "description": "If applicable diagnostics should be \"outsourced\" to a different process", - "default": true - }, - "language_server.diagnostic_exclude_paths": { - "description": "List of paths to exclude from diagnostics, e.g. `vendor\/**\/*`", - "default": [] - }, - "language_server.file_events": { "description": "Register to receive file events", "default": true }, - "language_server.file_event_globs": { "description": null, "default": ["**\/*.php"] }, - "language_server.profile": { "description": "Logs timing information for incoming LSP requests", "default": false }, - "language_server.trace": { - "description": "Log incoming and outgoing messages (needs log formatter to be set to ``json``)", - "default": false - }, - "language_server.shutdown_grace_period": { - "description": "Amount of time (in milliseconds) to wait before responding to a shutdown notification", - "default": 200 - }, - "language_server.phpactor_bin": { - "description": "Internal use only - name path to Phpactor binary", - "default": "\/opt\/phpactor\/lib\/Extension\/LanguageServer\/..\/..\/..\/bin\/phpactor" - }, - "language_server.self_destruct_timeout": { - "description": "Wait this amount of time (in milliseconds) after a shutdown request before self-destructing", - "default": 2500 - }, - "language_server.diagnostic_outsource_timeout": { - "description": "Kill the diagnostics process if it outlives this timeout", - "default": 5 - }, - "language_server_completion.trim_leading_dollar": { - "description": "If the leading dollar should be trimmed for variable completion suggestions", - "default": false - }, - "language_server_reference_reference_finder.reference_timeout": { - "description": "Stop searching for references after this time (in seconds) has expired", - "default": 60 - }, - "language_server_worse_reflection.workspace_index.update_interval": { - "description": "Minimum interval to update the workspace index as documents are updated (in milliseconds)", - "default": 100 - }, - "language_server_worse_reflection.inlay_hints.enable": { - "description": "Enable inlay hints (experimental)", - "default": false - }, - "language_server_worse_reflection.inlay_hints.types": { - "description": "Show inlay type hints for variables", - "default": false - }, - "language_server_worse_reflection.inlay_hints.params": { - "description": "Show inlay hints for parameters", - "default": true - }, - "language_server_worse_reflection.diagnostics.enable": { "description": "Enable diagnostics", "default": true }, - "language_server_indexer.workspace_symbol_search_limit": { "description": null, "default": 250 }, - "language_server_indexer.reindex_timeout": { - "description": "Unconditionally reindex modified files every N seconds", - "default": 300 - }, - "language_server_code_transform.import_name.report_non_existing_names": { - "description": "Show an error if a diagnostic name cannot be resolved - can produce false positives", - "default": true - }, - "language_server_configuration.auto_config": { - "description": "Prompt to enable extensions which apply to your project on language server start", - "type": ["boolean"], - "default": true - }, - "indexer.enabled_watchers": { - "description": "List of allowed watchers. The first watcher that supports the current system will be used", - "type": ["object"], - "default": ["inotify", "watchman", "find", "php"] - }, - "indexer.index_path": { - "description": "Path where the index should be saved", - "type": ["string"], - "default": "%cache%\/index\/%project_id%" - }, - "indexer.include_patterns": { - "description": "Glob patterns to include while indexing", - "type": ["object"], - "default": ["\/**\/*.php", "\/**\/*.phar"] - }, - "indexer.exclude_patterns": { - "description": "Glob patterns to exclude while indexing", - "type": ["object"], - "default": ["\/vendor\/**\/Tests\/**\/*", "\/vendor\/**\/tests\/**\/*", "\/vendor\/composer\/**\/*"] - }, - "indexer.stub_paths": { - "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"], - "default": [] - }, - "indexer.poll_time": { - "description": "For polling indexers only: the time, in milliseconds, between polls (e.g. filesystem scans)", - "type": ["integer"], - "default": 5000 - }, - "indexer.buffer_time": { - "description": "For real-time indexers only: the time, in milliseconds, to buffer the results", - "type": ["integer"], - "default": 500 - }, - "indexer.follow_symlinks": { - "description": "To allow indexer to follow symlinks", - "type": ["boolean"], - "default": false - }, - "indexer.project_root": { - "description": "The root path to use for scanning the index", - "type": ["string"], - "default": "%project_root%" - }, - "indexer.reference_finder.deep": { - "description": "Recurse over class implementations to resolve all references", - "type": ["boolean"], - "default": true - }, - "indexer.implementation_finder.deep": { - "description": "Recurse over class implementations to resolve all class implementations (not just the classes directly implementing the subject)", - "type": ["boolean"], - "default": true - }, - "indexer.supported_extensions": { - "description": "File extensions (e.g. `php`) for files that should be indexed", - "type": ["object"], - "default": ["php", "phar"] - }, - "object_renderer.template_paths.markdown": { - "description": "Paths in which to look for templates for hover information.", - "default": ["%project_config%\/templates\/markdown", "%config%\/templates\/markdown"] - }, - "language_server_phpstan.bin": { - "description": "Path to the PHPStan executable", - "default": "%project_root%\/vendor\/bin\/phpstan" - }, - "language_server_phpstan.level": { "description": "Override the PHPStan level" }, - "language_server_phpstan.config": { "description": "Override the PHPStan configuration file" }, - "language_server_phpstan.mem_limit": { "description": "Override the PHPStan memory limit" }, - "language_server_psalm.bin": { - "description": "Path to psalm if different from vendor\/bin\/psalm", - "type": ["string"], - "default": "%project_root%\/vendor\/bin\/psalm" - }, - "language_server_psalm.show_info": { - "description": "If infos from psalm should be displayed", - "type": ["boolean"], - "default": true - }, - "language_server_psalm.use_cache": { - "description": "If the Psalm cache should be used (see the `--no-cache` option)", - "type": ["boolean"], - "default": true - }, - "language_server_psalm.error_level": { - "description": "Override level at which Psalm should report errors (lower => more errors)" - }, - "language_server_psalm.threads": { - "description": "Set the number of threads Psalm should use. Warning: NULL will use as many as possible and may crash your computer", - "type": ["integer"], - "default": 1 - }, - "language_server_psalm.timeout": { - "description": "Kill the psalm process after this number of seconds", - "type": ["integer"], - "default": 15 - }, - "language_server_php_cs_fixer.bin": { - "description": "Path to the php-cs-fixer executable", - "default": "%project_root%\/vendor\/bin\/php-cs-fixer" - }, - "language_server_php_cs_fixer.env": { - "description": "Environment for PHP CS Fixer (e.g. to set PHP_CS_FIXER_IGNORE_ENV)", - "default": { "XDEBUG_MODE": "off", "PHP_CS_FIXER_IGNORE_ENV": true } - }, - "language_server_php_cs_fixer.show_diagnostics": { - "description": "Whether PHP CS Fixer diagnostics are shown", - "default": true - }, - "language_server_php_cs_fixer.config": { - "description": "Set custom PHP CS config path. Ex., %project_root%\/.php-cs-fixer.php" - }, - "php_code_sniffer.bin": { - "description": "Path to the phpcs executable", - "default": "%project_root%\/vendor\/bin\/phpcs" - }, - "php_code_sniffer.env": { - "description": "Environment for PHP_CodeSniffer (e.g. to set XDEBUG_MODE)", - "default": { "XDEBUG_MODE": "off" } - }, - "php_code_sniffer.show_diagnostics": { - "description": "Whether PHP_CodeSniffer diagnostics are shown", - "default": true - }, - "php_code_sniffer.args": { "description": "Additional arguments to pass to the PHPCS process", "default": [] }, - "php_code_sniffer.cwd": { "description": "Working directory for PHPCS" }, "behat.config_path": { - "description": "Path to the main behat.yml (including the filename behat.yml)", - "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": { "description": "If using Symfony, set this path to the XML container dump to find contexts which are defined as services" }, - "symfony.xml_path": { - "description": "Path to the Symfony container XML dump file", - "default": "%project_root%\/var\/cache\/dev\/App_KernelDevDebugContainer.xml" + "class_to_file.brute_force_conversion": { + "default": true, + "description": "If composer not found, fallback to scanning all files (very time consuming depending on project size)" + }, + "class_to_file.project_root": { + "default": "%project_root%", + "description": "Root path of the project (e.g. where composer.json is)" + }, + "code_transform.class_new.variants": { + "default": [], + "description": "Variants which should be suggested when class-create is invoked" + }, + "code_transform.import_globals": { + "default": false, + "description": "Import functions even if they are in the global namespace" + }, + "code_transform.indentation": { + "default": " ", + "description": "Indentation chars to use in code generation and transformation" + }, + "code_transform.refactor.generate_accessor.prefix": { + "default": "", + "description": "Prefix to use for generated accessors" + }, + "code_transform.refactor.generate_accessor.upper_case_first": { + "default": false, + "description": "If the first letter of a generated accessor should be made uppercase" + }, + "code_transform.refactor.generate_mutator.fluent": { + "default": false, + "description": "If the mutator should be fluent" + }, + "code_transform.refactor.generate_mutator.prefix": { + "default": "set", + "description": "Prefix to use for generated mutators" + }, + "code_transform.refactor.generate_mutator.upper_case_first": { + "default": true, + "description": "If the first letter of a generated mutator should be made uppercase" + }, + "code_transform.refactor.object_fill.hint": { + "default": true, + "description": "Object fill refactoring: show hint as a comment" + }, + "code_transform.refactor.object_fill.named_parameters": { + "default": true, + "description": "Object fill refactoring: use named parameters" + }, + "code_transform.template_paths": { + "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" + }, + "completion.dedupe_match_fqn": { + "default": true, + "description": "If ``completion.dedupe``, consider the class FQN in addition to the completion suggestion" + }, + "completion.label_formatter": { + "default": "helpful", + "description": "Definition of how to format entries in the completion list", + "enum": [ + "fqn", + "helpful" + ] + }, + "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." + }, + "completion_worse.completor.class.limit": { + "default": 100, + "description": "Suggestion limit for the filesystem based SCF class_completor" + }, + "completion_worse.completor.class_like.enabled": { + "default": true, + "description": "Enable or disable the ``class_like`` completor.\n\nCompletion for class like contexts." + }, + "completion_worse.completor.class_member.enabled": { + "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.constructor.enabled": { + "default": true, + "description": "Enable or disable the ``constructor`` completor.\n\nCompletion for constructors." + }, + "completion_worse.completor.declared_class.enabled": { + "default": true, + "description": "Enable or disable the ``declared_class`` completor.\n\nCompletion for classes defined in the Phpactor runtime." + }, + "completion_worse.completor.declared_constant.enabled": { + "default": true, + "description": "Enable or disable the ``declared_constant`` completor.\n\nCompletion for constants defined in the Phpactor runtime." + }, + "completion_worse.completor.declared_function.enabled": { + "default": true, + "description": "Enable or disable the ``declared_function`` completor.\n\nCompletion for functions defined in the Phpactor runtime." + }, + "completion_worse.completor.docblock.enabled": { + "default": true, + "description": "Enable or disable the ``docblock`` completor.\n\nDocblock completion." + }, + "completion_worse.completor.doctrine_annotation.enabled": { + "default": true, + "description": "Enable or disable the ``doctrine_annotation`` completor.\n\nCompletion for annotations provided by the Doctrine annotation library." + }, + "completion_worse.completor.expression_name_search.enabled": { + "default": true, + "description": "Enable or disable the ``expression_name_search`` completor.\n\nCompletion for class names, constants and functions at expression positions that are located in the index." + }, + "completion_worse.completor.imported_names.enabled": { + "default": true, + "description": "Enable or disable the ``imported_names`` completor.\n\nCompletion for names imported into the current namespace." + }, + "completion_worse.completor.keyword.enabled": { + "default": true, + "description": "Enable or disable the ``keyword`` completor.\n\nCompletion for keywords (not very accurate)." + }, + "completion_worse.completor.local_variable.enabled": { + "default": true, + "description": "Enable or disable the ``local_variable`` completor.\n\nCompletion for local variables." + }, + "completion_worse.completor.named_parameter.enabled": { + "default": true, + "description": "Enable or disable the ``named_parameter`` completor.\n\nCompletion for named parameters." + }, + "completion_worse.completor.scf_class.enabled": { + "default": true, + "description": "Enable or disable the ``scf_class`` completor.\n\nBrute force completion for class names (not recommended)." + }, + "completion_worse.completor.subscript.enabled": { + "default": true, + "description": "Enable or disable the ``subscript`` completor.\n\nCompletion for subscript (array access from array shapes)." }, "completion_worse.completor.symfony.enabled": { - "description": "Enable\/disable the Symfony completor - depends on Symfony extension being enabled", - "default": true + "default": true, + "description": "Enable/disable the Symfony completor - depends on Symfony extension being enabled" + }, + "completion_worse.completor.type.enabled": { + "default": true, + "description": "Enable or disable the ``type`` completor.\n\nCompletion for scalar types." + }, + "completion_worse.completor.use.enabled": { + "default": true, + "description": "Enable or disable the ``use`` completor.\n\nCompletion for use imports." + }, + "completion_worse.completor.worse_parameter.enabled": { + "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.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" + }, + "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", + "description": "Path to project's autoloader, can be an array" + }, + "composer.class_maps_only": { + "default": true, + "description": "Register the composer class maps only, do not register the autoloader - RECOMMENDED" + }, + "composer.enable": { + "default": true, + "description": "Include of the projects autoloader to facilitate class location. Note that when including an autoloader code _may_ be executed. This option may be disabled when using the indexer" + }, + "console.decorated": { + "description": "Whether to decorate messages (null for auto-guessing)", + "enum": [ + true, + false, + null + ] + }, + "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" + }, + "core.min_memory_limit": { + "default": 1610612736, + "description": "Ensure that PHP has a memory_limit of at least this amount in bytes" + }, + "core.project_config_candidates": { + "default": [], + "description": "(internal) list of potential project-level configuration files" + }, + "core.trust": { + "default": { + "path": null, + "trust": [] + }, + "description": "(internal) map of trusted project directories" + }, + "core.trusted": { + "default": false, + "description": "(internal) if the configuration is trusted" + }, + "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" + ] + }, + "indexer.enabled_watchers": { + "default": [ + "find", + "inotify", + "php", + "watchman" + ], + "description": "List of allowed watchers. The first watcher that supports the current system will be used", + "type": [ + "object" + ] + }, + "indexer.exclude_patterns": { + "default": [ + "/vendor/**/tests/**/*", + "/vendor/**/Tests/**/*", + "/vendor/composer/**/*", + "/vendor/rector/rector/stubs-rector" + ], + "description": "Glob patterns to exclude while indexing", + "type": [ + "object" + ] + }, + "indexer.follow_symlinks": { + "default": false, + "description": "To allow indexer to follow symlinks", + "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" + ] + }, + "indexer.include_patterns": { + "default": [ + "/**/*.phar", + "/**/*.php" + ], + "description": "Glob patterns to include while indexing", + "type": [ + "object" + ] + }, + "indexer.index_path": { + "default": "%cache%/index/%project_id%", + "description": "Path where the index should be saved", + "type": [ + "string" + ] + }, + "indexer.max_filesize_to_index": { + "default": 1000000, + "description": "Files larger than this will not be indexed. (Size in bytes)", + "type": [ + "integer" + ] + }, + "indexer.poll_time": { + "default": 5000, + "description": "For polling indexers only: the time, in milliseconds, between polls (e.g. filesystem scans)", + "type": [ + "integer" + ] + }, + "indexer.project_root": { + "default": "%project_root%", + "description": "The root path to use for scanning the index", + "type": [ + "string" + ] + }, + "indexer.reference_finder.deep": { + "default": true, + "description": "Recurse over class implementations to resolve all references", + "type": [ + "boolean" + ] + }, + "indexer.search_include_patterns": { + "default": [], + "description": "When searching the index exclude records whose fully qualified names match any of these regex patterns (use to exclude suggestions from search results). Namespace separators must be escaped as `\\\\\\\\` for example `^Foo\\\\\\\\` to include all namespaces whose first segment is `Foo`", + "type": [ + "object" + ] + }, + "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" + ] + }, + "indexer.supported_extensions": { + "default": [ + "phar", + "php" + ], + "description": "File extensions (e.g. `php`) for files that should be indexed", + "type": [ + "object" + ] + }, + "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/**/*`" + }, + "language_server.diagnostic_ignore_codes": { + "default": [], + "description": "Ignore diagnostics that have the codes listed here, e.g. [\"fix_namespace_class_name\"]. The codes match those shown in the LSP client." + }, + "language_server.diagnostic_outsource": { + "default": true, + "description": "If applicable diagnostics should be \"outsourced\" to a different process" + }, + "language_server.diagnostic_outsource_timeout": { + "default": 5, + "description": "Kill the diagnostics process if it outlives this timeout" + }, + "language_server.diagnostic_providers": { + "description": "Specify which diagnostic providers should be active (default to all)" + }, + "language_server.diagnostic_sleep_time": { + "default": 1000, + "description": "Amount of time to wait before analyzing the code again for diagnostics" + }, + "language_server.diagnostics_on_open": { + "default": true, + "description": "Perform diagnostics when opening a text document" + }, + "language_server.diagnostics_on_save": { + "default": true, + "description": "Perform diagnostics when the text document is saved" + }, + "language_server.diagnostics_on_update": { + "default": true, + "description": "Perform diagnostics when the text document is updated" + }, + "language_server.enable_trust_check": { + "default": true, + "description": "Check to see if project path is trusted before loading configurations from it" + }, + "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)" + }, + "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", + "description": "Internal use only - name path to Phpactor binary" + }, + "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" + }, + "language_server.session_parameters": { + "default": [], + "description": "Phpactor parameters (config) that apply only to the language server session" + }, + "language_server.shutdown_grace_period": { + "default": 200, + "description": "Amount of time (in milliseconds) to wait before responding to a shutdown notification" + }, + "language_server.trace": { + "default": false, + "description": "Log incoming and outgoing messages (needs log formatter to be set to ``json``)" + }, + "language_server_code_transform.import_globals": { + "default": false, + "description": "Show hints for non-imported global classes and functions" + }, + "language_server_code_transform.import_name.report_non_existing_names": { + "default": true, + "description": "Show an error if a diagnostic name cannot be resolved - can produce false positives" + }, + "language_server_completion.trim_leading_dollar": { + "default": false, + "description": "If the leading dollar should be trimmed for variable completion suggestions" + }, + "language_server_configuration.auto_config": { + "default": true, + "description": "Prompt to enable extensions which apply to your project on language server start", + "type": [ + "boolean" + ] + }, + "language_server_highlight.enabled": { + "default": true, + "description": "Enable or disable the highlighter (can be expensive on large documents)" + }, + "language_server_indexer.optimiser_timeout": { + "default": 3600, + "description": "Optimise the index every N seconds", + "type": [ + "integer" + ] + }, + "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_php_cs_fixer.bin": { + "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" + }, + "language_server_php_cs_fixer.env": { + "default": { + "XDEBUG_MODE": "off" + }, + "description": "Environment for PHP CS Fixer" + }, + "language_server_php_cs_fixer.show_diagnostics": { + "default": true, + "description": "Whether PHP CS Fixer diagnostics are shown" + }, + "language_server_php_cs_fixer.version": { + "description": "Arbitrary version (if not provided, phpactor tries to detect it - only to run it on unsupported PHP versions)" + }, + "language_server_phpstan.bin": { + "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.editor_mode": { + "default": false, + "description": "DEPRECATED. Editor mode of Phpstan is used automatically when it's supported." + }, + "language_server_phpstan.level": { + "description": "Override the PHPStan level" + }, + "language_server_phpstan.mem_limit": { + "description": "Override the PHPStan memory limit" + }, + "language_server_phpstan.severity": { + "default": 1, + "description": "Severity at which PHPStan diagnostics should be reported. Ranges from 1 (error) to 4 (hint)." + }, + "language_server_phpstan.tmp_file_disabled": { + "default": false, + "description": "Disable the use of temporary files when. This prevents as-you-type diagnostics, but ensures paths in phpstan config are respected. See https://github.com/phpactor/phpactor/issues/2763" + }, + "language_server_psalm.bin": { + "default": "%project_root%/vendor/bin/psalm", + "description": "Path to psalm if different from vendor/bin/psalm", + "type": [ + "string" + ] + }, + "language_server_psalm.config": { + "default": "", + "description": "Path to psalm config. Like %project_root%/psalm.xml", + "type": [ + "string" + ] + }, + "language_server_psalm.error_level": { + "description": "Override level at which Psalm should report errors (lower => more errors)" + }, + "language_server_psalm.show_info": { + "default": true, + "description": "If infos from psalm should be displayed", + "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" + ] + }, + "language_server_psalm.timeout": { + "default": 15, + "description": "Kill the psalm process after this number of seconds", + "type": [ + "integer" + ] + }, + "language_server_psalm.use_cache": { + "default": true, + "description": "If the Psalm cache should be used (see the `--no-cache` option)", + "type": [ + "boolean" + ] + }, + "language_server_reference_finder.soft_timeout": { + "default": 10, + "description": "Interupt and ask for confirmation to continue after this timeout (in seconds)" + }, + "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.inlay_hints.enable": { + "default": false, + "description": "Enable inlay hints (experimental)" + }, + "language_server_worse_reflection.inlay_hints.params": { + "default": true, + "description": "Show inlay hints for parameters" + }, + "language_server_worse_reflection.inlay_hints.types": { + "default": false, + "description": "Show inlay type hints for variables" + }, + "language_server_worse_reflection.workspace_index.update_interval": { + "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 + }, + "logging.level": { + "default": "warning", + "description": null, + "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 + }, + "object_renderer.template_paths.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.bin": { + "default": "%project_root%/vendor/bin/phpcs", + "description": "Path to the phpcs executable" + }, + "php_code_sniffer.cwd": { + "description": "Working directory for PHPCS" + }, + "php_code_sniffer.env": { + "default": { + "XDEBUG_MODE": "off" + }, + "description": "Environment for PHP_CodeSniffer (e.g. to set XDEBUG_MODE)" + }, + "php_code_sniffer.show_diagnostics": { + "default": true, + "description": "Whether PHP_CodeSniffer diagnostics are shown" }, "public_services_only": { - "description": "Only consider public services when providing analysis for the service locator", - "default": false + "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 + }, + "symfony.xml_path": { + "default": "%project_root%/var/cache/dev/App_KernelDevDebugContainer.xml", + "description": "Path to the Symfony container XML dump file" + }, + "worse_reflection.additive_stubs": { + "default": [], + "description": "Additive stubs files relative to the project root. These stubs augment existing defininitions." + }, + "worse_reflection.cache_dir": { + "default": "%cache%/worse-reflection", + "description": "Cache directory for stubs" + }, + "worse_reflection.cache_lifetime": { + "default": 1, + "description": "If caching is enabled, limit the amount of time a cache entry can stay alive" + }, + "worse_reflection.diagnostics.undefined_variable.suggestion_levenshtein_disatance": { + "default": 4, + "description": "Levenshtein distance to use when suggesting corrections for variable names", + "type": [ + "integer" + ] + }, + "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", + "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" } - } + }, + "title": "Phpactor Configuration Schema", + "type": "object" } diff --git a/phpstan.neon b/phpstan.neon index fc243960..5076bcdd 100755 --- a/phpstan.neon +++ b/phpstan.neon @@ -21,6 +21,8 @@ parameters: reportWrongPhpDocTypeInVarTag: true # Setting treatPhpDocTypesAsCertain to false relaxes some of the rules around type-checking. treatPhpDocTypesAsCertain: true + # PHP silently casts array keys that look like decimal integers from string to int. This means array can’t guarantee that keys are actually strings at runtime. + reportUnsafeArrayStringKeyCasting: true parallel: jobSize: 20 diff --git a/playwright.config.ts b/playwright.config.ts deleted file mode 100644 index ae98dd4b..00000000 --- a/playwright.config.ts +++ /dev/null @@ -1,92 +0,0 @@ -import { defineConfig, devices } from "@playwright/test"; - -/** - * Read environment variables from file. - * https://github.com/motdotla/dotenv - */ -// import dotenv from 'dotenv'; -// import path from 'path'; -// dotenv.config({ path: path.resolve(__dirname, '.env') }); - -/** - * See https://playwright.dev/docs/test-configuration. - */ -export default defineConfig({ - testDir: "./tests", - /* Run tests in files in parallel */ - fullyParallel: true, - /* Fail the build on CI if you accidentally left test.only in the source code. */ - forbidOnly: !!process.env.CI, - /* Retry on CI only */ - retries: process.env.CI ? 2 : 0, - /* Opt out of parallel tests on CI. */ - workers: process.env.CI ? 1 : undefined, - /* Reporter to use. See https://playwright.dev/docs/test-reporters */ - reporter: "list", - /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */ - use: { - /* Base URL to use in actions like `await page.goto('/')`. */ - // baseURL: 'http://localhost:3000', - - /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */ - trace: "on-first-retry", - clientCertificates: [ - { - origin: "https://haikuatelier.gcch.local", - certPath: "../certs/_wildcard.gcch.local.pem", - keyPath: "../certs/_wildcard.gcch.local-key.pem", - }, - ], - ignoreHTTPSErrors: true, - }, - - /* Configure projects for major browsers */ - projects: [ - { - name: "desktop-chromium-1920", - use: { ...devices["Desktop Chrome"], viewport: { width: 1920, height: 1080 } }, - }, - { - name: "desktop-chromium-1536", - use: { ...devices["Desktop Chrome"], viewport: { width: 1536, height: 864 } }, - }, - { - name: "desktop-chromium-1366", - use: { ...devices["Desktop Chrome"], viewport: { width: 1366, height: 768 } }, - }, - { - name: "desktop-firefox-1920", - use: { ...devices["Desktop Firefox"], viewport: { width: 1920, height: 1080 } }, - }, - { - name: "desktop-firefox-1536", - use: { ...devices["Desktop Firefox"], viewport: { width: 1536, height: 864 } }, - }, - { - name: "desktop-firefox-1366", - use: { ...devices["Desktop Firefox"], viewport: { width: 1366, height: 768 } }, - }, - { - name: "tablet-chromium-portrait", - use: { ...devices["Galaxy Tab S9"] }, - }, - { - name: "tablet-chromium-landscape", - use: { ...devices["Galaxy Tab S9 landscape"] }, - }, - { - name: "mobile-chromium-portrait", - use: { ...devices["Pixel 7"] }, - }, - { - name: "mobile-chromium-landscape", - use: { ...devices["Pixel 7 landscape"] }, - }, - ], - /* Run your local dev server before starting the tests */ - // webServer: { - // command: 'npm run start', - // url: 'http://localhost:3000', - // reuseExistingServer: !process.env.CI, - // }, -}); diff --git a/prettier.config.js b/prettier.config.js deleted file mode 100755 index 8199699f..00000000 --- a/prettier.config.js +++ /dev/null @@ -1,8 +0,0 @@ -import { configClassique, configXml } from "@gcch/configuration-prettier"; - -const config = { - ...configClassique, - overrides: [configXml], -}; - -export default config; diff --git a/rector.php b/rector.php deleted file mode 100644 index 6dae3866..00000000 --- a/rector.php +++ /dev/null @@ -1,24 +0,0 @@ -withPaths([__DIR__ . '/web/app/themes/haiku-atelier-2024']) - ->withSkip([__DIR__ . '/vendor', __DIR__ . '/node_modules']) - ->withPhpSets(php85: true) - ->withCodeQualityLevel(10) - ->withCodingStyleLevel(10) - ->withDeadCodeLevel(10) - ->withTypeCoverageDocblockLevel(10) - ->withTypeCoverageLevel(10) - ->withImportNames( - importDocBlockNames: true, - importNames: true, - importShortClasses: true, - removeUnusedImports: true, - ) - ->withPreparedSets( - carbon: true, - instanceOf: true, - privatization: true, - ); diff --git a/scripts/SCRIPT.fish b/scripts/SCRIPT.fish deleted file mode 100755 index 84de067f..00000000 --- a/scripts/SCRIPT.fish +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/fish - -for image in *.png - gm convert -resize 1000 $image ok-$image.png -end - -flaca -p * diff --git a/scripts/SUBSET.fish b/scripts/SUBSET.fish deleted file mode 100755 index e430fd1d..00000000 --- a/scripts/SUBSET.fish +++ /dev/null @@ -1,19 +0,0 @@ -pyftsubset \ - lato-variable-italic.ttf \ - --desubroutinize \ - --flavor=woff2 \ - --layout-features-="dnom,frac,numr" \ - --layout-features+="case,pnum,tnum" \ - --output-file="lato-variable-italic-webfont.woff2" \ - --unicodes="U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+2000-206F,U+2074,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD" \ - --with-zopfli - - -pyftsubset \ - lato-variable-italic.ttf \ - --desubroutinize \ - --layout-features-="dnom,frac,numr" \ - --layout-features+="case,pnum,tnum" \ - --output-file="lato-variable-italic-webfont.ttf" \ - --unicodes="U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+2000-206F,U+2074,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD" \ - --with-zopfli \ No newline at end of file diff --git a/scripts/convertis-images.fish b/scripts/convertis-images.fish new file mode 100755 index 00000000..6b163f9f --- /dev/null +++ b/scripts/convertis-images.fish @@ -0,0 +1,68 @@ +#!/usr/bin/fish + +for jpg in **/*.{jpg,jpeg} + echo $jpg + + set -f avif (path change-extension 'avif' "$jpg") + set -f jxl (path change-extension 'jxl' "$jpg") + set -f png (path change-extension 'png' "$jpg") + + set -f dimensions (magick identify -format "%w-%h" $jpg) + set -f dimensions (string split "-" $dimensions) + + if test $dimensions[1] -eq 1920 || test $dimensions[2] -eq 1920 + set -f a_bonnes_dimensions true + else + set -f a_bonnes_dimensions false + end + + if test -e $avif && test -e $jxl + echo -e "\tAll there." + continue + end + + magick "$jpg" -resize 1920x1920\> "$png" >/dev/null + + if ! test -e $jxl + if test $a_bonnes_dimensions = false + cjxl \ + --allow_jpeg_reconstruction=1 \ + --brotli_effort=11 \ + --container=1 \ + --effort=9 \ + --lossless_jpeg=1 \ + --num_threads=-1 \ + --progressive \ + $png $jxl &>/dev/null + + djxl \ + --num_threads=-1 \ + $jxl $jpg &>/dev/null + end + + cjxl \ + --allow_jpeg_reconstruction=0 \ + --brotli_effort=11 \ + --container=1 \ + --effort=10 \ + --quality=70 \ + --lossless_jpeg=0 \ + --num_threads=-1 \ + --progressive \ + $png $jxl &>/dev/null + echo -e "\t$jxl" + + set -f avif (path change-extension 'avif' "$jpg") + if ! test -e $avif + avifenc \ + -q 70 \ + -s 0 \ + -c aom \ + -y 420 \ + "$png" "$avif" &>/dev/null + echo -e "\t$avif" + end + + rm $png + end +end diff --git a/scripts/déclenche-sauvegarde-bdd-production.fish b/scripts/déclenche-sauvegarde-bdd-production.fish new file mode 100755 index 00000000..2d496558 --- /dev/null +++ b/scripts/déclenche-sauvegarde-bdd-production.fish @@ -0,0 +1,4 @@ +#!/usr/bin/fish + +ssh ade -- fish /srv/haikuatelier.com/scripts/sauvegarde-bdd-production.fish +rclone copy --check-first --progress --multi-thread-streams 8 ade:/srv/haikuatelier.com/db /home/gcch/Répertoires/git.gcch.fr/gcch/haiku-atelier-2024/db diff --git a/scripts/format-sort-files.fish b/scripts/format-sort-files.fish old mode 100644 new mode 100755 index 59dda2ba..df8488dd --- a/scripts/format-sort-files.fish +++ b/scripts/format-sort-files.fish @@ -1,5 +1,12 @@ +#!/usr/bin/fish + set -f fichiers_toml (fd --glob "*.toml") +set -f fichiers_angie (fd --glob "*.conf" containers/conf/angie) for toml in $fichiers_toml - taplo format "$toml" + tombi format "$toml" +end + +for angie in $angie + nginxfmt "$angie" end diff --git a/scripts/importe-dernier-export-bdd.ts b/scripts/importe-dernier-export-bdd.ts new file mode 100644 index 00000000..fc1b1fe8 --- /dev/null +++ b/scripts/importe-dernier-export-bdd.ts @@ -0,0 +1,96 @@ +import { $ } from "bun"; +import type { Option } from "effect"; +import { Array as FxArray, Console, Context, Effect, Layer, ManagedRuntime, Order, pipe, Schema } from "effect"; +import type { UnknownError } from "effect/Cause"; +import { readdir } from "node:fs/promises"; + +class PodmanError extends Schema.TaggedErrorClass()("PodmanError", { + cause: Schema.Error, +}) {} + +class FSError extends Schema.TaggedErrorClass()("FSError", { + cause: Schema.Error, +}) {} + +class Podman extends Context.Service< + Podman, + { + launchContainers(): Effect.Effect; + importLatestDbInWordPressContainer(exportPath: string): Effect.Effect; + } +>()("haikuatelier.fr/scripts/importe-dernier-export-bdd/Podman") { + static readonly layer = Layer.effect( + Podman, + // oxlint-disable-next-line require-yield + Effect.gen(function*() { + const launchContainers = Effect.fn("launchContainers")(function*() { + return yield* pipe( + 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*( + 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()), + Effect.mapError((error: UnknownError) => new PodmanError({ cause: error })), + ); + }); + + return Podman.of({ + launchContainers, + importLatestDbInWordPressContainer, + }); + }), + ); +} + +class FS extends Context.Service< + FS, + { + getLatestDbExport(): Effect.Effect; + } +>()("haikuatelier.fr/scripts/importe-dernier-export-bdd/FS") { + static readonly layer = Layer.effect( + FS, + // oxlint-disable-next-line require-yield + Effect.gen(function*() { + const getLatestDbExport = Effect.fn("getLatestDbExport")(function*() { + return yield* pipe( + 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 FSError({ cause: new Error("Aucun export de BDD n'est disponible.") })), + ); + }); + + return FS.of({ + getLatestDbExport, + }); + }), + ); +} + +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()); + yield* Console.log("Containers are launched."); + + 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* Console.log("Import done."); +}); + +runtime.runFork(program().pipe(Effect.tapError(Console.error))); diff --git a/scripts/pull-container-images.ts b/scripts/pull-container-images.ts index da11a9f6..107461b2 100644 --- a/scripts/pull-container-images.ts +++ b/scripts/pull-container-images.ts @@ -1,42 +1,88 @@ -import { BunFile, YAML } from "bun"; -import { Array, Console, Effect, Option, pipe, Record, Schema } from "effect"; -import { type UnknownException } from "effect/Cause"; -import { type ParseError } from "effect/ParseResult"; -import { type ReadonlyRecord } from "effect/Record"; +import { YAML } from "bun"; +import { Array as EffectArray, Console, Data, Effect, pipe, Record, Schema, SchemaIssue } from "effect"; +import { SchemaError } from "effect/Schema"; const COMPOSE_PATH = "compose.yaml"; +const DEFAULT_CMD_TIMEOUT = 10_000; +class Compose extends Schema.Class("Compose")({ + name: Schema.String, + services: Schema.Record(Schema.String, Schema.Unknown), +}) {} -const getServicesKey = ( - yaml: ReadonlyRecord, -): Option.Option> => - pipe( - Record.get("services")(yaml), - Option.andThen(yaml => Record.keys(yaml)), - ); +class ScriptError extends Data.TaggedError("ScriptError")<{ cause: unknown }> {} -const getComposeYaml = ( - filePath: string, - schema: Schema.Schema, -): Effect.Effect => - pipe( - Effect.try(() => Bun.file(filePath)), - Effect.andThen((file: BunFile) => Effect.tryPromise(() => file.text())), - Effect.andThen((text: string) => Effect.try(() => YAML.parse(text))), - Effect.andThen((yaml: unknown) => Schema.decodeUnknown(schema)(yaml)), - ); +// Const composeSchema = Schema.Record(Schema.Union([Schema.String, Schema.Symbol]), Schema.Unknown); +// type YamlRecord = ReadonlyRecord; -const programEffect: Effect.Effect> = Effect.gen(function*() { +/* */ + +/** + * Retourne les noms des services déclarés dans un ficher _Compose_. + * @param compose Le fichier _Compose_ sous forme d'objet. + * @returns Les noms des Services sous forme de tableau. + */ +const getServicesFromComposeYaml: (compose: Compose) => ReadonlyArray = compose => + Record.keys(compose.services); + +/** + * Récupère le contenu texte d'un fichier pour un chemin donné. + * + * @param filePath Le chemin du fichier dont on souhaite le contenu. + * @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) { + const fileRef: Bun.BunFile = Bun.file(filePath); + + yield* Effect.tryPromise({ + catch: (_): ScriptError => new ScriptError({ cause: "The wanted file does not exist." }), + try: async (): Promise => fileRef.exists(), + }); + + return yield* Effect.tryPromise({ + catch: (_): ScriptError => new ScriptError({ cause: "Can't retrieve the file's text content." }), + try: async (): Promise => fileRef.text(), + }); + }, +); + +/** + * Récupère le contenu _YAML_ d'un fichier _Compose_ sous forme de `Record`. + * + * @param path Le chemin du fichier _Compose_. + * @param schema Le `Schema` utilisée pour le parsage des données du fichier. + * @returns Un `Record` des données du fichier. + */ +const getComposeYaml: ( + path: string, + schema: Schema.Schema, +) => Effect.Effect = Effect.fn("getComposeYaml")(function*(path, schema) { return yield* pipe( - // Récupère le contenu du fichier compose.yaml sous forme de Record. - getComposeYaml(COMPOSE_PATH, Schema.Record({ key: Schema.String, value: Schema.Unknown })), - // Récupère la clé des services. - Effect.andThen((yaml: ReadonlyRecord) => getServicesKey(yaml)), - // Retire la clé de l'image WordPress. - Effect.andThen((keys: ReadonlyArray) => Array.filter(keys, key => key !== "wordpress")), - Effect.orElseSucceed(() => [""]), - // Exécute la commande podman. - Effect.tap(services => Bun.spawn({ cmd: ["podman", "compose", "pull", ...services], timeout: 10000 })), + getFileContent(path), + Effect.map((text: string): unknown => YAML.parse(text)), + Effect.flatMap((yaml: unknown) => + Schema.decodeUnknownEffect(schema)(yaml, { errors: "all", onExcessProperty: "ignore" }) + ), + Effect.mapError((error): ScriptError => { + if (error instanceof SchemaError) { + return new ScriptError({ cause: SchemaIssue.makeFormatterStandardSchemaV1()(error.issue) }); + } else { + return error; + } + }), ); }); -Effect.runFork(programEffect).pipe(Effect.tapErrorCause(Console.error)); +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.orElseSucceed(() => [""]), + Effect.tap((services: ReadonlyArray) => { + Bun.spawn({ cmd: ["podman", "compose", "pull", ...services], timeout: DEFAULT_CMD_TIMEOUT }); + return Effect.succeed(services); + }), + Effect.tapCause(Console.error), +); + +Effect.runFork(program); diff --git a/scripts/remove-scaled-images.php b/scripts/remove-scaled-images.php index c543ca59..678f8f36 100755 --- a/scripts/remove-scaled-images.php +++ b/scripts/remove-scaled-images.php @@ -1,4 +1,6 @@ -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/scripts/sauvegarde-bdd-production.fish b/scripts/sauvegarde-bdd-production.fish old mode 100644 new mode 100755 index cadf47b5..484ae0fd --- a/scripts/sauvegarde-bdd-production.fish +++ b/scripts/sauvegarde-bdd-production.fish @@ -1,3 +1,5 @@ +#!/usr/bin/fish + cd /srv/haikuatelier.com/web sudo -S wp-cli --allow-root db export sudo -S mv -v /srv/haikuatelier.com/web/*.sql ../db diff --git a/scripts/subset-polices.fish b/scripts/subset-polices.fish new file mode 100755 index 00000000..4dd99b7d --- /dev/null +++ b/scripts/subset-polices.fish @@ -0,0 +1,20 @@ +#!/usr/bin/fish + +pyftsubset \ + lato-variable-italic.ttf \ + --desubroutinize \ + --flavor=woff2 \ + --layout-features-="dnom,frac,numr" \ + --layout-features+="case,pnum,tnum" \ + --output-file="lato-variable-italic-webfont.woff2" \ + --unicodes="U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+2000-206F,U+2074,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD" \ + --with-zopfli + +pyftsubset \ + lato-variable-italic.ttf \ + --desubroutinize \ + --layout-features-="dnom,frac,numr" \ + --layout-features+="case,pnum,tnum" \ + --output-file="lato-variable-italic-webfont.ttf" \ + --unicodes="U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+2000-206F,U+2074,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD" \ + --with-zopfli diff --git a/stylelint.config.js b/stylelint.config.js deleted file mode 100755 index a2e14054..00000000 --- a/stylelint.config.js +++ /dev/null @@ -1,40 +0,0 @@ -// @ts-expect-error -- La dépendance ne dispose pas de types. -import { propertyGroups } from "stylelint-config-clean-order"; - -/** @type {string[][]} */ -// eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- Impossible de typer correctement avec JSDoc. -const groupesProprietes = Array.from(/** @type {GroupeProprietes} */ propertyGroups); - -/** @import { StylelintConfigCleanOrderPropertyGroup } from "./lib/stylelint" */ -/** @type {Array} */ -const ordreProprietes = groupesProprietes.map(properties => ({ - emptyLineBefore: "never", - noEmptyLineBetween: true, - properties, -})); - -/** @type {import("stylelint").Config} */ -export default { - extends: ["stylelint-config-standard-scss", "stylelint-config-sass-guidelines", "stylelint-config-clean-order"], - plugins: ["stylelint-declaration-block-no-ignored-properties"], - rules: { - "@stylistic/function-parentheses-space-inside": null, - "@stylistic/selector-list-comma-newline-after": null, - "@stylistic/string-quotes": null, - "custom-property-pattern": null, - "declaration-block-no-duplicate-custom-properties": true, - "declaration-block-no-duplicate-properties": true, - "declaration-block-no-redundant-longhand-properties": true, - "declaration-block-no-shorthand-property-overrides": true, - "max-nesting-depth": null, - "no-descending-specificity": null, - "no-duplicate-selectors": [true, { disallowInList: false }], - "order/properties-order": [ordreProprietes, { severity: "error", unspecified: "bottomAlphabetical" }], - "plugin/declaration-block-no-ignored-properties": true, - "selector-class-pattern": null, - "selector-id-pattern": null, - "selector-max-compound-selectors": null, - "selector-max-id": null, - "selector-no-qualifying-type": null, - }, -}; diff --git a/tests/capture.spec.ts b/tests/playwright/capture.spec.ts similarity index 71% rename from tests/capture.spec.ts rename to tests/playwright/capture.spec.ts index 0ce1cea2..2a6b0fa2 100644 --- a/tests/capture.spec.ts +++ b/tests/playwright/capture.spec.ts @@ -1,14 +1,12 @@ -import { expect, type Page, test } from "@playwright/test"; +import { expect, test } from "@playwright/test"; +import type { Page } from "@playwright/test"; type TestPage = { pageName: string; url: string; }; -const genTimestamp = (): string => - Intl.DateTimeFormat("sv-SE", { - dateStyle: "short", - }).format(Date.now()); +const genTimestamp = (): string => Intl.DateTimeFormat("sv-SE", { dateStyle: "short" }).format(Date.now()); const takeFullPageScreenshot = async (page: Page, name: string): Promise => { await page.screenshot({ fullPage: false, path: `captures/${name}`, type: "png" }); @@ -38,14 +36,16 @@ Array.from([ url: "https://haikuatelier.gcch.local/product/fuyou-long-earrings-silver/", }, ]).forEach(({ pageName, url }) => { - test(pageName, async ({ page }, testInfo) => { + test.skip(pageName, async ({ page }, testInfo) => { await page.goto(url); const projectName = testInfo.project.name; const timestamp: string = genTimestamp(); - const viewport = page.viewportSize(); + const viewportSize = page.viewportSize() ?? { height: 0, width: 0 }; - const captureName = `${pageName}/${projectName}-${viewport?.width}-${viewport?.height} ${timestamp}.png`; + const captureName = `${pageName}/${projectName}-${String(viewportSize.width)}-${ + String(viewportSize.height) + } ${timestamp}.png`; await takeFullPageScreenshot(page, captureName); await expect(page).toHaveURL(url); diff --git a/tests/playwright/product.spec.ts b/tests/playwright/product.spec.ts new file mode 100644 index 00000000..a71f4b5f --- /dev/null +++ b/tests/playwright/product.spec.ts @@ -0,0 +1,120 @@ +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 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 + * On doit pouvoir naviguer sur la page + * Le produit ne DOIT pas avoir de variations (pour l'instant) + * Le bouton d'ajout du panier doit être visible + * (Si le produit n'est pas en stock) On ne doit pas pouvoir ajouter le produit au panier + * Le bouton doit afficher le texte "Out of stock" + * Le bouton doit être désactivé + */ + +type ProductsFixture = { + products: ProductsKinds; +}; + +type ProductsKinds = { + allProducts: WCV3Products; + simpleProducts: WCV3Products; + simpleProductsWithoutStock: WCV3Products; + simpleProductsWithStock: WCV3Products; +}; + +export const test = base.extend({ + products: async ({ page, request }, use) => { + 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", { + headers: { Authorization: `Basic ${backendHeaders.authString}`, Nonce: backendHeaders.nonce }, + }); + expect(response.ok(), "The API returned the list of every Product").toBeTruthy(); + + const isSimpleProduct = (product: WCV3Product) => product.type === "simple"; + const hasStock = (product: WCV3Product) => (product.stock_quantity ?? 0) > 0; + const hasNoStock = (product: WCV3Product) => pipe(hasStock(product), not); + + const allProducts = (await response.json()) as WCV3Products; + const simpleProducts = allProducts.filter(isSimpleProduct); + const simpleProductsWithStock = simpleProducts.filter(hasStock); + const simpleProductsWithoutStock = simpleProducts.filter(hasNoStock); + + const kinds = { + allProducts, + simpleProducts, + simpleProductsWithoutStock, + simpleProductsWithStock, + } satisfies ProductsKinds; + + await use(kinds); + }, +}); + +test("can add a Product without variation with stock to the Cart", async ({ page, products }) => { + // Prend un produit au hasard. + const randomProductIndex = getRandomIntInclusive(0, products.simpleProductsWithStock.length - 1); + const randomProduct = products.simpleProductsWithStock.at(randomProductIndex); + expect(randomProduct, "The selected random Product must exist").toBeTruthy(); + if (randomProduct === undefined) { + throw new Error("The random product can't be undefined"); + } + + // Va à la page du Produit. + 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" }); + await addToCartButton.scrollIntoViewIfNeeded(); + await expect(addToCartButton, "The add to cart button must be visible").toBeVisible(); + await expect(addToCartButton, "The add to cart button must be enabled").toBeEnabled(); + + // Vérifie qu'au clic sur le bouton, l'ajout au Panier retourne un succès. + const addToCartResponse: Promise = page.waitForResponse(new RegExp(".*/wp-json/wc/store/cart/add-item")); + await addToCartButton.click(); + const addToCartStatus = (await addToCartResponse).ok(); + expect(addToCartStatus, "The cart addition must succeed").toBeTruthy(); + + // Vérifie que le bouton ait changé de texte. + const addedToCartButton = page.getByRole("button", { name: "Added to cart!" }); + expect(addedToCartButton, "The add to cart button's text has changed").toBeDefined(); + + // Vérifie que le compteur d'articles dans le Panier soit incrémenté. + const cartLink = page.getByRole("link", { name: "cart (1)" }); + expect(cartLink, "The cart items' indicator has been incremented").toBeDefined(); +}); + +test("can't add a Product without variation without stock to the Cart", async ({ page, products }) => { + // Prend un produit au hasard. + const randomProductIndex = getRandomIntInclusive(0, products.simpleProductsWithoutStock.length - 1); + const randomProduct = products.simpleProductsWithoutStock.at(randomProductIndex); + expect(randomProduct, "The selected random Product must exist").toBeTruthy(); + if (randomProduct === undefined) { + throw new Error("The random product can't be undefined"); + } + + // Va à la page du Produit. + 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" }); + await outOfStockButton.scrollIntoViewIfNeeded(); + await expect(outOfStockButton, "The add to cart button must be visible").toBeVisible(); + await expect(outOfStockButton, "The add to cart button must be disabled").toBeDisabled(); +}); + +const getRandomIntInclusive = (min: number, max: number): number => { + const minCeiled = Math.ceil(min); + const maxFloored = Math.floor(max); + + return Math.floor(Math.random() * (maxFloored - minCeiled + 1) + minCeiled); +}; diff --git a/tests/playwright/shop.spec.ts b/tests/playwright/shop.spec.ts new file mode 100644 index 00000000..465f4816 --- /dev/null +++ b/tests/playwright/shop.spec.ts @@ -0,0 +1,70 @@ +/** @effect-diagnostics asyncFunction:skip-file */ +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 }); + +test("can scroll to the end of the grid", async ({ page }): Promise => { + await scrollToGridsEnd(page); +}); + +test("can access all Products' pages", async ({ page, request }): Promise => { + 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); + await expect(req, "The Product's page is accessible").toBeOK(); + } +}); + +const getAllProductsLinks = async (page: Page, request: APIRequestContext): Promise> => { + const backendHeaders: BackendHeaders = await getBackendHeadersFromHtml(page); + const response = await request.get("/wp-json/wc/v3/products?page=1&per_page=100&status=publish", { + headers: { Authorization: `Basic ${backendHeaders.authString}`, Nonce: backendHeaders.nonce }, + }); + const json = (await response.json()) as WCV3Products; + return json.map(p => p.permalink); +}; + +const scrollToGridsEnd = async (page: Page): Promise => { + await page["goto"]("https://haikuatelier.gcch.local/shop/"); + + let hasMoreProducts = true; + let currentPageNumber = "1"; + + const productsGrid: Locator = page.locator(".grille-produits"); + await expect(productsGrid, "The Product's grid is visible").toBeVisible(); + expect(await productsGrid.getAttribute("data-page"), "The initial page number attribute is correct").toBe( + currentPageNumber, + ); + + const showMoreButton: Locator = page.getByRole("button", { name: "Show more" }); + await expect(showMoreButton, "The 'Show more' button is visible").toBeVisible(); + + while (hasMoreProducts) { + const newProductsResponse: Promise = page.waitForResponse(new RegExp(".*wp-json/wc/v3/products.*")); + await showMoreButton.click(); + await newProductsResponse; + + const newPageNumber = String(Number(currentPageNumber) + 1); + // Créé un nouveau Locator que l'on attend pour s'assurer que l'attribut soit bien mis à jour. + const gridWithNewPageNumber = page.locator(`.grille-produits[data-page="${newPageNumber}"]`); + await gridWithNewPageNumber.waitFor(); + + // Redondance pour expliciter la raison de l'assertion. + expect(await productsGrid.getAttribute("data-page"), "The page number attribute is incremented").toBe( + newPageNumber, + ); + currentPageNumber = newPageNumber; + + // La fin de la grille est atteint. + if (await showMoreButton.isHidden()) { + hasMoreProducts = false; + } + } +}; diff --git a/tests/playwright/utils.ts b/tests/playwright/utils.ts new file mode 100644 index 00000000..87778b5c --- /dev/null +++ b/tests/playwright/utils.ts @@ -0,0 +1,24 @@ +import { Option, pipe } from "effect"; +import type { Page } from "playwright/test"; + +export type BackendHeaders = { + authString: string; + nonce: string; +}; + +/** + * @throws Lève une exception si la balise du JSON est introuvable. + */ +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.getOrUndefined, + ); + + if (backendHeaders === undefined) { + throw new Error("The JSON of the backend headers in the page's HTML can't be null."); + } + + return backendHeaders; +}; diff --git a/tsconfig.json b/tsconfig.json index fbb77606..42793b84 100755 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,4 +1,5 @@ { + "$schema": "https://raw.githubusercontent.com/Effect-TS/tsgo/refs/heads/main/schema.json", "compilerOptions": { "allowArbitraryExtensions": true, "allowImportingTsExtensions": true, @@ -8,12 +9,17 @@ "allowUnusedLabels": false, "alwaysStrict": true, "checkJs": true, - "downlevelIteration": false, "esModuleInterop": true, "exactOptionalPropertyTypes": true, "forceConsistentCasingInFileNames": true, "isolatedModules": true, - "lib": ["DOM", "DOM.Iterable", "ESNext"], + "lib": [ + "DOM", + "DOM.AsyncIterable", + "DOM.Iterable", + "ESNext" + ], + "libReplacement": true, "module": "ESNext", "moduleDetection": "force", "moduleResolution": "Bundler", @@ -25,24 +31,96 @@ "noImplicitReturns": true, "noImplicitThis": true, "noPropertyAccessFromIndexSignature": true, - "noStrictGenericChecks": false, "noUncheckedIndexedAccess": true, "noUncheckedSideEffectImports": true, "noUnusedLocals": true, "noUnusedParameters": true, + "plugins": [ + { + "diagnosticSeverity": { + "anyUnknownInErrorContext": "error", + "asyncFunction": "warning", + "catchAllToMapError": "error", + "catchUnfailableEffect": "error", + "classSelfMismatch": "error", + "cryptoRandomUUID": "warning", + "cryptoRandomUUIDInEffect": "warning", + "deterministicKeys": "off", + "duplicatePackage": "warning", + "effectDoNotation": "error", + "effectFnIife": "error", + "effectFnImplicitAny": "error", + "effectFnOpportunity": "error", + "effectGenUsesAdapter": "error", + "effectInFailure": "error", + "effectInVoidSuccess": "error", + "effectMapFlatten": "warning", + "effectMapVoid": "error", + "effectSucceedWithVoid": "error", + "extendsNativeError": "warning", + "floatingEffect": "error", + "genericEffectServices": "off", + "globalConsole": "warning", + "globalConsoleInEffect": "warning", + "globalDate": "warning", + "globalDateInEffect": "warning", + "globalErrorInEffectCatch": "warning", + "globalErrorInEffectFailure": "warning", + "globalFetch": "warning", + "globalFetchInEffect": "warning", + "globalRandom": "warning", + "globalRandomInEffect": "warning", + "globalTimers": "warning", + "globalTimersInEffect": "warning", + "instanceOfSchema": "warning", + "layerMergeAllWithDependencies": "suggestion", + "lazyPromiseInEffectSync": "error", + "leakingRequirements": "warning", + "missedPipeableOpportunity": "warning", + "multipleEffectProvide": "error", + "newPromise": "warning", + "nodeBuiltinImport": "warning", + "nonObjectEffectServiceType": "error", + "outdatedApi": "error", + "preferSchemaOverJson": "warning", + "processEnv": "warning", + "processEnvInEffect": "warning", + "redundantSchemaTagIdentifier": "error", + "returnEffectInGen": "warning", + "runEffectInsideEffect": "error", + "scopeInLayerEffect": "warning", + "strictEffectProvide": "warning", + "tryCatchInEffectGen": "error", + "unnecessaryArrowBlock": "suggestion", + "unnecessaryEffectGen": "suggestion", + "unnecessaryFailYieldableError": "suggestion", + "unnecessaryPipe": "warning", + "unnecessaryPipeChain": "warning" + }, + "name": "@effect/language-service" + } + ], "skipLibCheck": false, "strict": true, "strictBindCallApply": true, "strictFunctionTypes": true, "strictNullChecks": true, "strictPropertyInitialization": true, - "suppressExcessPropertyErrors": false, - "suppressImplicitAnyIndexErrors": false, "target": "ESNext", - "types": ["node", "vite/client"], + "types": [ + "node", + "vite/client" + ], "useDefineForClassFields": true, "useUnknownInCatchVariables": true }, - "exclude": ["vendor", "web/app/plugins", "web/wp"], - "include": ["*.js", "lib", "web/app/themes/haiku-atelier-2024/src", "vite.config.ts"] + "exclude": [ + "vendor", + "web/app/plugins", + "web/wp" + ], + "include": [ + "**/*.js", + "**/*.ts" + ] } diff --git a/web/app/mu-plugins/bedrock-autoloader.php b/web/app/mu-plugins/bedrock-autoloader.php index 646f4a8e..dc405b47 100755 --- a/web/app/mu-plugins/bedrock-autoloader.php +++ b/web/app/mu-plugins/bedrock-autoloader.php @@ -1,4 +1,5 @@ diff --git a/web/app/themes/haiku-atelier-2024/404.php b/web/app/themes/haiku-atelier-2024/404.php index 3bbe3840..dd1b631e 100755 --- a/web/app/themes/haiku-atelier-2024/404.php +++ b/web/app/themes/haiku-atelier-2024/404.php @@ -1,32 +1,34 @@ $informations_produits Les informations brutes des Produits. */ -$informations_produits = wc_get_products([ - 'limit' => 12, - 'order' => 'DESC', - 'orderby' => 'date', - 'status' => 'publish', -]); +/** @var list $wc_products Les informations brutes des Produits. */ +$wc_products = wc_get_products(['limit' => 12, 'order' => 'DESC', 'orderby' => 'date', 'status' => 'publish']); -/** @var mixed $produits Les informations strictement nécessaires pour la grille des Produits. */ -$produits = array_map( - callback: recupere_informations_produit_shop(...), - array: $informations_produits, -); -$contexte['produits'] = $produits; +$products = array_map(callback: Product::from_wc_product(...), array: $wc_products); +$context['products'] = $products; -/** - * Charge les Scripts nécessaires pour la page Boutique. - */ -function charge_scripts_page_boutique(): void { - wp_enqueue_style( - handle: 'haiku-atelier-2024-styles-page-boutique', - src: get_template_directory_uri() . '/assets/css/pages/page-boutique.css', - deps: [], - ver: filemtime(get_template_directory() . '/assets/css/pages/page-boutique.css'), - media: 'all', - ); - wp_enqueue_script_module( - id: 'haiku-atelier-2024-scripts-page-boutique', - src: get_template_directory_uri() . '/assets/js/scripts-page-boutique.js', - deps: [], - version: filemtime(get_template_directory() . '/assets/js/scripts-page-boutique.js'), - ); - wp_enqueue_script_module( - id: 'haiku-atelier-2024-scripts-menu-categories', - src: get_template_directory_uri() . '/assets/js/scripts-menu-categories.js', - deps: [], - version: filemtime(get_template_directory() . '/assets/js/scripts-menu-categories.js'), - ); -} +// Injecte les états initiaux des données du Produit sous forme de JSON dans le contexte. +$page_states = ['authString' => Config::get('WOOCOMMERCE_API_AUTH_STRING'), 'nonce' => wp_create_nonce('wc_store_api')] + |> wp_json_encode(...); +assert(is_string($page_states)); +$context['page_states'] = $page_states; -add_action('wp_enqueue_scripts', 'charge_scripts_page_boutique'); +add_action('wp_enqueue_scripts', function (): void { + Resource::enqueue_style_file( + handle: 'haiku-atelier-2024-styles-page-boutique', + path : '/assets/css/pages/page-boutique.css', + ); + Resource::enqueue_script_module_file( + id : 'haiku-atelier-2024-scripts-page-boutique', + path: '/assets/js/scripts-page-boutique.js', + ); + Resource::enqueue_script_module_file( + id : 'haiku-atelier-2024-scripts-menu-categories', + path: '/assets/js/scripts-menu-categories.js', + ); +}); -// Rendu -Timber::render( - filenames: $modeles, - data: $contexte, -); +Timber::render(data: $context, filenames: $templates); diff --git a/web/app/themes/haiku-atelier-2024/assets/css/main.css b/web/app/themes/haiku-atelier-2024/assets/css/main.css index 1525c43b..99bd30bc 100755 --- a/web/app/themes/haiku-atelier-2024/assets/css/main.css +++ b/web/app/themes/haiku-atelier-2024/assets/css/main.css @@ -4,16 +4,66 @@ font-weight: 100 900; font-style: normal; font-display: swap; - src: url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.woff2") format(woff2) tech(variations), url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.woff2") format("woff2-variations"), url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.woff2") format("woff2"), url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.ttf") format("truetype"); - unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; + src: + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.woff2") + format(woff2) tech(variations), + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.woff2") + format("woff2-variations"), + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.woff2") + format("woff2"), + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-webfont.ttf") + format("truetype"); + unicode-range: + U+0000-00FF, + U+0131, + U+0152-0153, + U+02BB-02BC, + U+02C6, + U+02DA, + U+02DC, + U+2000-206F, + U+2074, + U+20AC, + U+2122, + U+2191, + U+2193, + U+2212, + U+2215, + U+FEFF, + U+FFFD; } @font-face { font-family: Lato; font-weight: 100 900; font-style: italic; font-display: swap; - src: url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.woff2") format(woff2) tech(variations), url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.woff2") format("woff2-variations"), url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.woff2") format("woff2"), url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.ttf") format("truetype"); - unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; + src: + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.woff2") + format(woff2) tech(variations), + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.woff2") + format("woff2-variations"), + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.woff2") + format("woff2"), + url("/app/themes/haiku-atelier-2024/assets/fonts/lato/lato-variable-italic-webfont.ttf") + format("truetype"); + unicode-range: + U+0000-00FF, + U+0131, + U+0152-0153, + U+02BB-02BC, + U+02C6, + U+02DA, + U+02DC, + U+2000-206F, + U+2074, + U+20AC, + U+2122, + U+2191, + U+2193, + U+2212, + U+2215, + U+FEFF, + U+FFFD; } @font-face { font-family: Myriad; @@ -21,7 +71,10 @@ font-style: normal; font-display: swap; font-stretch: 70% 110%; - src: url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable.woff2") format("woff2"), url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable.ttf") format("truetype"); + src: + url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable.woff2") format("woff2"), + url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable.ttf") + format("truetype"); } @font-face { font-family: Myriad; @@ -29,21 +82,25 @@ font-style: italic; font-display: swap; font-stretch: 70% 110%; - src: url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable-italic.woff2") format("woff2"), url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable-italic.ttf") format("truetype"); + src: + url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable-italic.woff2") + format("woff2"), + url("/app/themes/haiku-atelier-2024/assets/fonts/myriad/myriad-variable-italic.ttf") + format("truetype"); } :root { /* Couleurs */ - --couleur-blanc: #fff; - --couleur-blanc-fond: rgb(255 255 255 / 90%); - --couleur-gris: #eceaeb; - --couleur-gris-fonce: #808080; - --couleur-gris-fonce-fond: rgb(128 128 128 / 80%); - --couleur-bordeaux: #490918; - --couleur-bordeaux-fond: rgb(73 9 24 / 80%); - --couleur-jaune: #defdb5; - --couleur-jaune-fond: rgb(235 255 184 / 80%); - --couleur-noir: #202020; - --couleur-fond: rgb(236 234 235 / 80%); + --couleur-blanc: oklch(100% 0 0deg / 100%); + --couleur-blanc-fond: oklch(100% 0 0deg / 80%); + --couleur-gris: oklch(93.89% 0.0025 345.21deg / 100%); + --couleur-gris-fond: oklch(93.89% 0.0025 345.21deg / 80%); + --couleur-gris-fond-extra: oklch(93.89% 0.0025 345.21deg / 60%); + --couleur-gris-fonce: oklch(59.99% 0 0deg / 100%); + --couleur-gris-fonce-fond: oklch(59.99% 0 0deg / 80%); + --couleur-noir: oklch(24.35% 0 0deg / 100%); + /* Arrières-plan */ + --arriere-plan-points: repeating-conic-gradient(var(--couleur-noir) 0% 25%, transparent 0% 100%) + 1px 0.5px/2px 2px; /* Polices */ --police-lato: "Lato", sans-serif; /* Hauteurs de ligne */ @@ -82,6 +139,7 @@ * 1. Utilise un meilleur modèle de boîte. */ html { + scrollbar-gutter: stable; box-sizing: border-box; /* 1 */ } @@ -112,7 +170,7 @@ html { */ body { overscroll-behavior: none; - accent-color: var(--couleur-jaune); /* 2 */ + accent-color: var(--couleur-gris-fonce); /* 2 */ background: var(--couleur-gris); /* 1 */ } @@ -127,7 +185,7 @@ button, input, select, textarea { * Change la couleur d'arrière-plan à la sélection du texte. */ *::selection { - background: var(--couleur-jaune); + background: var(--couleur-gris-fonce); } /* Cache tout élément avec l'attribut hidden */ @@ -159,16 +217,17 @@ button, input, select, textarea { /* * Désactive les animations pour les Utilisateurs n'en souhaitant pas. */ -@media (prefers-reduced-motion) { +/* @media (prefers-reduced-motion) { *, *::before, *::after { scroll-behavior: auto !important; transition: none !important; animation-duration: 0s !important; } + @view-transition { navigation: none !important; } -} +} */ /* * 2. Rendu spécifique du texte pour Safari/iOS. * 3. Rendu plus précis du texte. @@ -176,14 +235,15 @@ button, input, select, textarea { html { font: 1rem/var(--hauteur-ligne-classique) Lato; font-optical-sizing: auto; + font-variant-ligatures: common-ligatures no-discretionary-ligatures no-historical-ligatures + contextual; font-kerning: normal; - font-variant-ligatures: common-ligatures no-discretionary-ligatures no-historical-ligatures contextual; - -webkit-font-smoothing: antialiased; /* 2 */ color: var(--couleur-noir); text-decoration-skip-ink: auto; text-size-adjust: none; /* 2 */ text-rendering: geometricprecision; /* 3 */ letter-spacing: var(--espacement-inter-lettres-etendu-s); + -webkit-font-smoothing: antialiased; /* 2 */ } strong { @@ -194,6 +254,11 @@ em { font-style: italic; } +code { + font-family: monospace; + font-size: 0.9rem; +} + /* Mixins Sass */ /* * Réinitialisation des styles des {# Pied de page #} diff --git a/web/app/themes/haiku-atelier-2024/views/boutique.twig b/web/app/themes/haiku-atelier-2024/views/boutique.twig index f9c1f45f..96c07369 100755 --- a/web/app/themes/haiku-atelier-2024/views/boutique.twig +++ b/web/app/themes/haiku-atelier-2024/views/boutique.twig @@ -1,13 +1,14 @@ {% extends 'base.twig' %} {% block head %} - {% endblock head %} @@ -21,10 +22,8 @@
diff --git a/web/app/themes/haiku-atelier-2024/views/cgv.twig b/web/app/themes/haiku-atelier-2024/views/cgv.twig index f0c7d088..1d10ec98 100755 --- a/web/app/themes/haiku-atelier-2024/views/cgv.twig +++ b/web/app/themes/haiku-atelier-2024/views/cgv.twig @@ -1,10 +1,7 @@ {% extends 'base.twig' %} {% block contenu %} -
+

Terms & Conditions

@@ -17,22 +14,15 @@

- Each piece, made in sterling silver and 18k gold plated silver, is made to order. As soon as we receive your - order, depending on its complexity, production in our workshop will take between 2 to 7 working days. It - will then be send to you, at the latest, within 14 days of your order. + Each piece, made in sterling silver and 18k gold plated silver, is made to order. As soon as we receive your order, depending on its complexity, production in our workshop will take between 2 to 7 working days. It will then be send to you, at the latest, within 14 days of your order.

- The products are delivered by Mondial Relay or UPS. Products are delivered in France, Europe, and any - country included by those two delivery companies.

+ The products are delivered by Mondial Relay or UPS. Products are delivered in France, Europe, and any country included by those two delivery companies.

- The details of delivery costs and times are specified in during the payment process. The delivery times are - mentioned for information only. When the order is sent, the customers will receive an e-mail from the - carrier allowing them to track their package. + The details of delivery costs and times are specified in during the payment process. The delivery times are mentioned for information only. When the order is sent, the customers will receive an e-mail from the carrier allowing them to track their package.

- Haiku Atelier cannot be held responsible for delays in delivery due to errors or disruptions attributable to - carriers (including in the event of a total or partial strike in particular of the postal services and means - of transport and/or communications). + Haiku Atelier cannot be held responsible for delays in delivery due to errors or disruptions attributable to carriers (including in the event of a total or partial strike in particular of the postal services and means of transport and/or communications).

@@ -42,21 +32,14 @@

- If for any reason you are not satisfied with your purchase, we will refund or exchange it within 14 days of - receipt. If more than 30 days have past since your purchase, unfortunately, we cannot offer a refund or an - exchange. + If for any reason you are not satisfied with your purchase, we will refund or exchange it within 14 days of receipt. If more than 30 days have past since your purchase, unfortunately, we cannot offer a refund or an exchange.

- To be eligible for a return or an exchange, your item must be in the same condition as received, unworn and - unused, in its original packaging. You will also need the receipt or proof of purchase. + To be eligible for a return or an exchange, your item must be in the same condition as received, unworn and unused, in its original packaging. You will also need the receipt or proof of purchase.

- To start a return you can contact us at haiku.atelier@gmail.com. Please note that returns and exchange will need to be send back our workshop - in Brussels. + To start a return you can contact us at haiku.atelier@gmail.com. Please note that returns and exchange will need to be send back our workshop in Brussels.

@@ -64,15 +47,11 @@

- The site does not provide any return labels. Return costs are the responsibility of the customer. Taxes or - duties on international deliveries are non-refundable. Haiku Atelier undertakes to reimburse the price of - the product and the initial shipping costs, upon receipt of the product. + The site does not provide any return labels. Return costs are the responsibility of the customer. Taxes or duties on international deliveries are non-refundable. Haiku Atelier undertakes to reimburse the price of the product and the initial shipping costs, upon receipt of the product.

- Once the returned product has been quality checked and approved, the refund will be made via the original - method of payment used for the returned order and a confirmation email will be sent to the customer. Haiku - Atelier is not responsible for items purchased from other retailers. + Once the returned product has been quality checked and approved, the refund will be made via the original method of payment used for the returned order and a confirmation email will be sent to the customer. Haiku Atelier is not responsible for items purchased from other retailers.

@@ -82,17 +61,11 @@

- Please inspect your order upon receipt and contact us immediately if the item is defective, damaged, or if - you received the wrong item. Make written observations at the latest within three (3) days following the - delivery, to Haiku Atelier, by sending a photograph of the product. Unfortunately we cannot accept returns - on sale items and gift cards. + Please inspect your order upon receipt and contact us immediately if the item is defective, damaged, or if you received the wrong item. Make written observations at the latest within three (3) days following the delivery, to Haiku Atelier, by sending a photograph of the product. Unfortunately we cannot accept returns on sale items and gift cards.

- Haiku Atelier jewelry are guarantee for a year. If your piece unexpectedly broke or loses its gold color - within a year, you can send it back to us and we will repair it for free, you will just have to organize - your own shipping label (our workshop is located in Brussels).
We still provide after sale services past - the guarantee year, the price of those services will be determined depending on each case. + Haiku Atelier jewelry are guarantee for a year. If your piece unexpectedly broke or loses its gold color within a year, you can send it back to us and we will repair it for free, you will just have to organize your own shipping label (our workshop is located in Brussels).
We still provide after sale services past the guarantee year, the price of those services will be determined depending on each case.

@@ -102,41 +75,27 @@

- This website is operated by Manon Designere - créatrice de bijoux, whose registered office is located at 45 - rue de Franceville, 93220 Gagny, France. These general terms and conditions of use and sale (the "GTCU") - govern the use of the site by any user wishing to access the site and make a purchase on the site (the - "User" or the "Customer"). + This website is operated by Manon Designere - créatrice de bijoux, whose registered office is located at 45 rue de Franceville, 93220 Gagny, France. These general terms and conditions of use and sale (the "GTCU") govern the use of the site by any user wishing to access the site and make a purchase on the site (the "User" or the "Customer").

- By accessing the site, the user acknowledges having read and fully and unreservedly accepts the GTCU. Haiku - Atelier reserves the right to modify the GTCU at any time. The change will take effect immediately upon - posting the GTCU. + By accessing the site, the user acknowledges having read and fully and unreservedly accepts the GTCU. Haiku Atelier reserves the right to modify the GTCU at any time. The change will take effect immediately upon posting the GTCU.

- The products governed by these GTCUs are those which appear on the site (the “Products”). The products are - offered for sale within the limits of available stocks. The site does not guarantee that the products will - be in stock. The site reserves the right to remove a product at any time for any reason. + The products governed by these GTCUs are those which appear on the site (the “Products”). The products are offered for sale within the limits of available stocks. The site does not guarantee that the products will be in stock. The site reserves the right to remove a product at any time for any reason.

- The colors, features, specifications, and details of the products are described and presented with the - greatest possible accuracy. However, the site does not warrant that the colors, features, specifications, - and details of the products will be accurate, complete, reliable, current, or free from other errors, and - users' digital display may not accurately reflect the actual colors and details of the products. + The colors, features, specifications, and details of the products are described and presented with the greatest possible accuracy. However, the site does not warrant that the colors, features, specifications, and details of the products will be accurate, complete, reliable, current, or free from other errors, and users' digital display may not accurately reflect the actual colors and details of the products.

- The prices of the products are indicated in Euros all taxes included, including the applicable French VAT - (20%). The prices of the products are exclusive of delivery costs (shipping, packaging, and making up the - package according to the applicable amounts). The amount of the delivery costs will be specified before the - validation of the order. The prices of the products may be modified at any time. However, a price cannot be - modified once the purchase order has been validated. + The prices of the products are indicated in Euros all taxes included, including the applicable French VAT (20%). The prices of the products are exclusive of delivery costs (shipping, packaging, and making up the package according to the applicable amounts). The amount of the delivery costs will be specified before the validation of the order. The prices of the products may be modified at any time. However, a price cannot be modified once the purchase order has been validated.

- The site uses the 3D Secure payment system to prevent fraud.
+ The site uses the 3D Secure payment system to prevent fraud.
Customers can pay for their purchase order:

@@ -146,24 +105,15 @@

- Haiku Atelier will not be held responsible for the failure to deliver a package due to an incorrect or - incomplete delivery address. Once the undelivered products have been collected by Haiku Atelier, a new - delivery will be possible and incur a reshipping fee invoiced to the customer. + Haiku Atelier will not be held responsible for the failure to deliver a package due to an incorrect or incomplete delivery address. Once the undelivered products have been collected by Haiku Atelier, a new delivery will be possible and incur a reshipping fee invoiced to the customer.

- International deliveries are subject to import charges, duties, taxes, or fees of the destination country. - These funds are set by the government of that country, in accordance with import/export regulations, and - billed by the courier. Haiku Atelier is not responsible for these duties, taxes, or other charges.
If a - package is returned because a customer has refused to pay any import taxes or customs duties owed, the - package refund will not include shipping and return costs. + International deliveries are subject to import charges, duties, taxes, or fees of the destination country. These funds are set by the government of that country, in accordance with import/export regulations, and billed by the courier. Haiku Atelier is not responsible for these duties, taxes, or other charges.
If a package is returned because a customer has refused to pay any import taxes or customs duties owed, the package refund will not include shipping and return costs.

- Haiku Atelier is the exclusive owner of all intellectual property rights or holds the rights of use relating - to both the structure and the content of the site. The GTCU are subject to French law, regardless of the - country of residence of the user and the place of placing the purchase order.
In the absence of an - amicable agreement, any dispute will be submitted to the competent French courts. + Haiku Atelier is the exclusive owner of all intellectual property rights or holds the rights of use relating to both the structure and the content of the site. The GTCU are subject to French law, regardless of the country of residence of the user and the place of placing the purchase order.
In the absence of an amicable agreement, any dispute will be submitted to the competent French courts.

@@ -173,16 +123,13 @@

- Contact:
- For inquiries and customer service, please refer to our Contact page. + Contact:
+ For inquiries and customer service, please refer to our Contact page.

- Credits:
- Webdesign by Manon Designere.
+ Credits:
+ Webdesign by Manon Designere.
Development by Gauthier Colin--Haag.

diff --git a/web/app/themes/haiku-atelier-2024/views/contact.twig b/web/app/themes/haiku-atelier-2024/views/contact.twig index c328e154..98c47caa 100755 --- a/web/app/themes/haiku-atelier-2024/views/contact.twig +++ b/web/app/themes/haiku-atelier-2024/views/contact.twig @@ -1,10 +1,7 @@ {% extends 'base.twig' %} {% block contenu %} -
+

Say hi!

@@ -12,16 +9,9 @@

- For any inquiries, from simple information questions to problems with your products, or just to say hi, don't - hesitate to contact us at + For any inquiries, from simple information questions to problems with your products, or just to say hi, don't hesitate to contact us at haikuatelier@gmail.com - or on Instagram at + or on Instagram at haiku.atelier .

diff --git a/web/app/themes/haiku-atelier-2024/views/echec-commande.twig b/web/app/themes/haiku-atelier-2024/views/echec-commande.twig index 2d46c2ba..b3be1373 100755 --- a/web/app/themes/haiku-atelier-2024/views/echec-commande.twig +++ b/web/app/themes/haiku-atelier-2024/views/echec-commande.twig @@ -1,22 +1,15 @@ {% extends 'base.twig' %} {% block contenu %} -
+

Failed order!

-

Sadly, something went wrong during your order, or you chose to cancel it. You can try again if you want: your - cart is still there.

-

If an error persists and you don't know what's going on, please don't hesitate to contact us!

+

Sadly, something went wrong during your order, or you chose to cancel it. You can try again if you want: your cart is still there.

+

If an error persists and you don't know what's going on, please don't hesitate to contact us!

diff --git a/web/app/themes/haiku-atelier-2024/views/macros/images.twig b/web/app/themes/haiku-atelier-2024/views/macros/images.twig index 26045ebb..fe7ed055 100755 --- a/web/app/themes/haiku-atelier-2024/views/macros/images.twig +++ b/web/app/themes/haiku-atelier-2024/views/macros/images.twig @@ -1,30 +1,14 @@ {% macro genere_source_img_multi_formats(rel_url, alt = '', width, height, id = '') %} - - - - + + + {{ alt }} + /> {% endmacro %} diff --git a/web/app/themes/haiku-atelier-2024/views/panier.twig b/web/app/themes/haiku-atelier-2024/views/panier.twig index 1642604b..024d7e88 100755 --- a/web/app/themes/haiku-atelier-2024/views/panier.twig +++ b/web/app/themes/haiku-atelier-2024/views/panier.twig @@ -1,21 +1,18 @@ {% extends 'base.twig' %} {% block head %} - {% endblock head %} {% block contenu %} -
+
{# « Your Cart » #} {{ include('parts/pages/panier/panneau-panier.twig') }} {# Your Info #} @@ -23,10 +20,7 @@

Sorry! Your cart is empty.

- + Go back to the Shop
diff --git a/web/app/themes/haiku-atelier-2024/views/parts/en-tete.twig b/web/app/themes/haiku-atelier-2024/views/parts/en-tete.twig index a8836f55..2e6d83ca 100755 --- a/web/app/themes/haiku-atelier-2024/views/parts/en-tete.twig +++ b/web/app/themes/haiku-atelier-2024/views/parts/en-tete.twig @@ -1,54 +1,39 @@
{# TODO: Utiliser un Menu WordPress ? #} -
@@ -72,40 +58,27 @@
+ /> @@ -115,27 +88,20 @@
-
+

Subtotal:

{{ sous_total_panier }}€

Discount:

-{{ sous_total_reduction }}€

-
+

Shipping:

{% if not adresse_renseignee %}

@@ -149,8 +115,7 @@

@@ -158,22 +123,17 @@ {% for methode_livraison in methodes_livraison %}
- + {{ methode_livraison.selectionnee ? 'checked' }} data-prix="{{ methode_livraison.prix }}" + id="methode-livraison-{{ methode_livraison.id }}" name="choix-methode-livraison" + type="radio" value="{{ methode_livraison.id }}" + /> +
{% endfor %}

- Belgium and France: free shipping on orders above 50€ (Pickup Point only).
+ Belgium and France: free shipping on orders above 50€ (Pickup Point only).
Worldwide: free shipping on orders above 100€.

diff --git a/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/grille-produits-similaires.twig b/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/grille-produits-similaires.twig index a22c5dd2..8984d239 100755 --- a/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/grille-produits-similaires.twig +++ b/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/grille-produits-similaires.twig @@ -1,24 +1,24 @@
- {% for produit in produits_meme_collection %} + {% for product in same_collection_products %} {# TODO: Trouver une meilleure arborescence et des noms de classe #}
- + - {{ produit.default_photo }} + {{ product.default_photo }} - {{ produit.hover_photo }} + {{ product.hover_photo }}

- {{ produit.name }} + {{ product.name }}

- {{ produit.price }}€ + {{ product.price }}€

diff --git a/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/informations-produit.twig b/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/informations-produit.twig index 37ec5236..04b5277b 100755 --- a/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/informations-produit.twig +++ b/web/app/themes/haiku-atelier-2024/views/parts/pages/produit/informations-produit.twig @@ -1,102 +1,50 @@ {# Barre flottante avec le nom du Produit, le sélecteur de variation et de quantité pour le Panier. #} -